API Commands For resellers of domain names and related services Version 4.3 March 13, 2009
3/13/09
1
© 2003-2009 Register.com, Inc.
Register.com, Incorporated ("Register.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). Register.com 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 Register.com 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 Register.com to you any Register.com® technology, and all rights, titles and interests in and to any Register.com technology and the API shall remain solely with Register.com. 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 Register.com’s 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 Register.com 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 Register.com, a royalty free license to use such IP Interests as required for Register.com’s 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 Register.com in writing. You shall not use the API to communicate with or to control a system other than system(s) designated by Register.com and you may not access or use Register.com’s 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, REGISTER.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. March 13, 2009
3/13/09
2
©2003-2009 Register.com, Inc.
Contents API command categories . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 API commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 AddBulkDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AddContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AddToCart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AdvancedDomainSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AuthorizeTLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertConfigureCert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertGetApproverEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertGetCertDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertGetCerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertModifyOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertParseCSR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertPurchaseCert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CheckLogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CheckNSStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CommissionAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CreateAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CreateSubAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteAllPOPPaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteCustomerDefinedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteFromCart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteHostedDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteNameServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeletePOP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeletePOPPak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteRegistration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteSubaccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DisableServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EnableServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3/13/09
15 18 21 31 37 40 47 50 54 57 60 63 66 69 72 75 77 81 86 89 91 93 95 97 99 102 104 106 109 111 113 116
3
©2003-2009 Register.com, Inc.
Extend_RGP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ExtendDomainDNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAccountPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAccountValidation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAddressBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAllAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAllDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetBalance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCartContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCatchAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetConfirmationSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetContacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCusPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCustomerDefinedData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCustomerPaymentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDNSStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainExp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainNameID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainSLDTLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainSRVHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainSubServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDotNameForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetExpiredDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetExtAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetExtendInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetFraudScore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetGlobalChangeStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetGlobalChangeStatusDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetHomeDomainList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetMailHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetMetaTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetOrderDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetOrderList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetPasswordBit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetPOP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetPOPExpirations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetPOPForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetRegHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetRegistrationStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetRegLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetRenew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetResellerInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3/13/09
:
120 123 127 130 133 135 137 141 144 147 149 152 154 157 160 164 167 170 173 175 177 180 182 187 189 193 196 198 201 204 206 208 211 215 218 221 224 227 230 233 236 239 241 244 247 249 253 256 259 262 264 267 270 273
4
©2003-2009 Register.com, Inc.
GetSPFHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetServiceContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetSubAccountDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetSubAccountPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetSubAccounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetSubaccountsDetailList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetTLDList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetTransHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetWhoisContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetWPPSInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_CancelAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_ChangePassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_CreateAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_GetAccountDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_GetAccounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_GetPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_UpgradeAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . InsertNewOrder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ModifyNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ModifyNSHosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ModifyPOP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NameSpinner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ParseDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetCustomerPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetDomainPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetPOPPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetProductPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetResellerPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetRetailPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetRetailPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetTLDID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_SetPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Preconfigure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Purchase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PurchaseHosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PurchasePOPBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PurchasePreview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PurchaseServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PushDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RefillAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RegisterNameServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RemoveTLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RenewPOPBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RenewServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RPT_GetReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SendAccountEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ServiceSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetCatchAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetCustomerDefinedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDNSHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDomainSRVHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDomainSubServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDotNameForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3/13/09
:
276 279 282 288 290 293 296 299 303 306 309 312 315 318 321 324 327 330 333 336 338 341 345 347 350 353 355 358 361 364 368 370 374 380 389 393 396 399 408 411 415 418 421 425 429 434 436 439 442 445 447 450 453 455
5
©2003-2009 Register.com, Inc.
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateExpiredDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateMetaTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateNameServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateNotificationAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdatePushList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateRenewalSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ValidatePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WSC_GetAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WSC_GetAllPackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WSC_GetPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WSC_Update_Ops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
:
458 460 462 465 468 471 474 477 480 483 486 489 491 494 500 503 507 511 514 517 520 524 527 529 533 538 543 547 549 553 555 558 560 562 565 568 570 575 579 582
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
3/13/09
6
©2003-2009 Register.com, Inc.
API command categories
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 GetConfirmationSettings GetExtAttributes GetTLDList NameSpinner Preconfigure Purchase Domain management commands—host records GetDomainSRVHosts GetHosts GetMetaTag GetRegHosts GetSPFHosts SetDomainSRVHosts SetHosts SetSPFHosts UpdateMetaTag
3/13/09
7
©2003-2009 Register.com, Inc.
API command categories:
Domain management commands—name servers CheckNSStatus DeleteNameServer GetDNS GetDNSStatus GetHomeDomainList ModifyNS ModifyNSHosting RegisterNameServer SetDNSHost UpdateNameServer
Domain management commands—contact information Contacts GetContacts GetExtAttributes GetWhoisContact
Domain management commands—general 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 renewal commands Extend Extend_RGP GetDomainExp GetExtendInfo GetRenew InsertNewOrder SetRenew UpdateExpiredDomains UpdateRenewalSettings
3/13/09
8
©2003-2009 Register.com, Inc.
API command categories:
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
Domain services DisableServices EnableServices GetDomainServices PurchaseServices RenewServices ServiceSelect
3/13/09
9
©2003-2009 Register.com, Inc.
API command categories:
Service management—e-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 management—identity protection DisableServices EnableServices GetWPPSInfo RenewServices
Service management—SSL certificates CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert GetCerts
Service management—Web Site Creator WSC_GetAccountInfo WSC_GetAllPackages WSC_GetPricing WSC_Update_Ops
3/13/09
10
©2003-2009 Register.com, 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 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 RefillAccount UpdateNotificationAmount
3/13/09
11
©2003-2009 Register.com, 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
3/13/09
12
©2003-2009 Register.com, Inc.
API commands
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. It’s 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—also called international domain names or IDNs—must be PUNY encoded. Most of our services are mix-and-match: You can use them in any combination for a single domain name as long as it’s either either registered with us or uses our DNS hosting. However, there are some exceptions as noted in the table below:
Service
Available for domains registered here
Available for domains that use our DNS hosting
Available for domains not registered here or using our DNS hosting
Our other services work when this service is enabled
SSL Certificates
Yes
Yes
Yes
Yes
ID Protect
Yes
Yes
No
Yes
Web Site Creator
Yes
Yes
No
Yes
POP Email
Yes
Yes
No
Yes
3/13/09
13
©2003-2009 Register.com, Inc.
API commands:
Service
Available for domains registered here
Available for domains that use our DNS hosting
Available for domains not registered here or using our DNS hosting
Our other services work when this service is enabled
Hosted Microsoft Exchange
Yes
Yes
No
Yes
Email Forwarding
Yes
Yes
No
Yes
URL Forwarding
Yes
Yes
No
Yes
3/13/09
14
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.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
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
ProductType
Required
Type of product to add. Options are register or renew.
16
ListCount
Required
Number of names to add
4
SLDX (X=1 to listcount)
Required
Second-level domain name, for example, partnerdomain in 63 partnerdomain.com
TLDX (X=1 to listcount)
Required
Top-level domain name, for example, com in partnerdomain.com
15
numyearsX (X=1 to listcount)
Optional
Number of years to renew
1
AutoRenew
Optional; default is 0
Auto-renew setting for all domains in this order. If AutoRenew=1, domains automatically update 30 days before expiration
1
RegLock
Optional; default is 1
Registrar lock setting for all domains in this order. If RegLock=1, domain cannot be transferred to another registrar without account holder’s permission
1
3/13/09
15
©2003-2009 Register.com, Inc.
API commands: AddBulkDomains
Param name Obligation Definition
Max size
UseCart
UseCart=1 is Required if UID is a retail account, otherwise Optional.
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.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query adds partnerdomain.com, partnerdomain2.net, and partnerdomain3.info to the shopping cart of account rcompartnerid, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=addbulkdomains& uid=rcompartnerid&pw=rcompartnerpw&producttype=register&listcount=3& sld1=partnerdomain&tld1=com&sld2=partnerdomain2&tld2=net& sld3=partnerdomain3&tld3=info&responsetype=xml
The response is as follows: partnerdomain.com 29.95 True partnerdomain2.net 29.95
3/13/09
16
©2003-2009 Register.com, Inc.
API commands: AddBulkDomains
True partnerdomain3.info 29.95 True True ADDBULKDOMAINS 0 ResellerTest rcom true
Related commands AddToCart Check DeleteFromCart GetCartContent InsertNewOrder Purchase PurchasePreview UpdateCart
3/13/09
17
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
RegistrantOrganizationName
Optional
Registrant organization
60
RegistrantJobTitle
Optional
Registrant job title
60
RegistrantFirstName
Required
Registrant first name
60
RegistrantLastName
Required
Registrant last name
60
RegistrantAddress1
Required
Registrant address
60
RegistrantAddress2
Optional
Registrant additional address info
60
RegistrantCity
Required
Registrant city
60
RegistrantPostalCode
Required
Registrant postal code
16
RegistrantStateProvince
Optional
Registrant state or province
60
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: S state P province
1
RegistrantCountry
Optional
Registrant country
60
RegistrantPhone
Required
Registrant phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
3/13/09
18
©2003-2009 Register.com, Inc.
API commands: AddContact
Param name
Obligation
Definition
Max size
RegistrantFax
Optional
Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantEmailAddress
Required
Email address for Whois
128
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition PartyID
Party ID number for this contact, assigned by us
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=addcontact& uid=rcompartnerid&pw=rcompartnerpw&RegistrantFirstName=john&RegistrantLastName=doe& RegistrantAddress1=111%20Main%20Street&RegistrantAddress2=Suite%20100& RegistrantCity=Hometown&RegistrantStateProvince=NY&RegistrantStateProvinceChoice=state& RegistrantPostalCode=99999&RegistrantCountry=us&RegistrantPhone=+800.5554444& RegistrantFax=+800.5554445&RegistrantEmailAddress=john.doe@partnerdomain.com& responsetype=xml
In the response, a Party ID and an ErrCount value of 0 confirm that the query was successful: {FFD61956-8D43-45FB-BC38-E0EE23331503} ADDCONTACT en 0 0 1 10 RESELLERTEST
3/13/09
19
©2003-2009 Register.com, Inc.
API commands: AddContact
e True True +03.00 0.3164063 true
Related commands Contacts GetAddressBook GetContacts GetExtAttributes GetResellerInfo GetServiceContact GetWhoisContact Preconfigure
3/13/09
20
©2003-2009 Register.com, 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 partners have access to this command.
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 RCOM Shield Input parameters for POP Email Input parameters Hosted Microsoft Exchange Input parameters for Email Forwarding and URL Forwarding Input parameters for Web Site Creator Input parameters for SSL certificates
Input parameters for domains Use the input parameters in the table below to add a domain name to the cart.
3/13/09
21
©2003-2009 Register.com, Inc.
API commands: AddToCart
Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2
Param name
Obligation
Definition
UID
Required
Account login ID
20
PW
Required
Account password
20
EndUserIP
Required
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
ProductType
Required
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
39
SLD
Required for Register Transfer Renew RGP Extended RGP Host Host Renew
Second-level domain name (for example, register in register.com)
63
TLD
Required for Register Transfer Renew RGP Extended RGP Host Host Renew
Top-level domain name (extension)
15
Quantity
Optional for Register Transfer Renew Host Host Renew; default is duration you set in UpdateCusPreferences
Number of years. Permitted values are 1 through 10; registration cannot extend beyond 10 years from today
2
AutoRenew
Optional for Register
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
RegLock
Optional for Register
Do you want protection against 10 unauthorized transfer of this domain name? Permitted values are 0 and 1
3/13/09
Max size
22
©2003-2009 Register.com, Inc.
API commands: AddToCart
Param name
Obligation
Definition
Max size
UsePerm
Required for Extended RGP
For Extended RGP, required value is UsePerm=ok
10
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.
3
ResponseType
Optional
4
Format of response. Options are Text (default), HTML, or XML.
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://partnertest.rcomexpress.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2
Param name
Obligation
Definition
UID
Required
Account login ID
20
PW
Required
Account password
20
EndUserIP
Required
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
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 Registry’s email forwarding service. If a .name domain is purchased using the shopping cart, the Registry’s email forwarding service is automatically bundled with the domain.)
SLD
Required for DotNameBundle DotNameForwarding
Second-level domain name (for example, register in register.com)
63
TLD
Required for DotNameBundle DotNameForwarding
Top-level domain name (extension)
15
Quantity
Optional; default is the duration you set in UpdateCusPreferences
Number of years
2
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.
3
ResponseType
Optional
4
3/13/09
Format of response. Options are Text (default), HTML, or XML.
Max size
23
©2003-2009 Register.com, Inc.
API commands: AddToCart
Input parameters for RCOM Shield Use the input parameters in the table below to add RCOM Shield to the cart. Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2
Param name
Obligation
Definition
UID
Required
Account login ID
20
PW
Required
Account password
20
EndUserIP
Required
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
ProductType
Required
Type of product to add. Permitted values are: RCOMShield (Whois Privacy Protection) RCOMShieldRenewal
39
SLD
Required for RCOMShield RCOMShieldRenewal
Second-level domain name (for example, register in register.com)
63
TLD
Required for RCOMShield RCOMShieldRenewal
Top-level domain name (extension)
15
Quantity
Optional; default is 1
Number of years
2
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.
3
ResponseType
Optional
4
Format of response. Options are Text (default), HTML, or XML.
Max size
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://partnertest.rcomexpress.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2
Param name
Obligation
Definition
UID
Required
Account login ID
20
PW
Required
Account password
20
EndUserIP
Required
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
3/13/09
Max size
24
©2003-2009 Register.com, Inc.
API commands: AddToCart
Param name
Obligation
Definition
Max size
ProductType
Required
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)
39
SLD
Required for POP Renew-POP EmailStorage
Second-level domain name (for example, register in register.com)
10
TLD
Required for POP Renew-POP EmailStorage
Top-level domain name (extension)
10
Quantity
Optional for POP Renew-POP EmailStorage
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.
ProductID
Required for Renew-POP EmailStorage
POP pak ID number. To retrieve this value, use the GetPOP3 command.
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.
3
ResponseType
Optional
4
Format of response. Options are Text (default), HTML, or XML.
3
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://partnertest.rcomexpress.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ProductType
Required
For Hosted Microsoft Exchange, permitted values are: HostedExchange HostedExchangeUpgrade
39
3/13/09
25
©2003-2009 Register.com, Inc.
API commands: AddToCart
Param name
Obligation
Definition
SLD
Optional for HostedExchange
63 Second-level domain name (for example, register in register.com) for email address
TLD
Optional for HostedExchange
Top-level domain name (extension) for email address
Zone
Optional for HostedExchange
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
Quantity
Optional for HostedExchange; default is 1
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).
StorageMBQty
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.
BlackBerryQty
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.
3
ActiveSyncQty
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.
3
3/13/09
Number of mailboxes to buy for a new Hosted Microsoft Exchange account. Permitted values are 1 to 255.
Max size
15
3
3
26
©2003-2009 Register.com, Inc.
API commands: AddToCart
Param name
Obligation
Definition
GoodLinkQty
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.
3
ClearItems
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.
3
ResponseType
Optional
4
Format of response. Options are Text (default), HTML, or XML.
Max size
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. Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2
Param name
Obligation
Definition
UID
Required
Account login ID
20
PW
Required
Account password
20
EndUserIP
Required
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
ProductType
Required
Type of product to add. Permitted values are: EmailForwarding EmailForwardingRenew URLForwarding URLForwardingRenew
39
SLD
Required for EmailForwarding EmailForwardingRenew URLForwarding URLForwardingRenew
Second-level domain name (for example, register in register.com)
63
TLD
Required for EmailForwarding EmailForwardingRenew URLForwarding URLForwardingRenew
Top-level domain name (extension)
15
3/13/09
Max size
27
©2003-2009 Register.com, Inc.
API commands: AddToCart
Param name
Obligation
Definition
Max size
Quantity
Optional for EmailForwarding EmailForwardingRenew URLForwarding URLForwardingRenew; default is 1
Number of years
2
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.
3
ResponseType
Optional
4
Format of response. Options are Text (default), HTML, or XML.
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://partnertest.rcomexpress.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20 20
PW
Required
Account password
EndUserIP
Required
End user’s IP address. This is used in fraud 15 checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
ProductType
Required
Type of product to add. Permitted values are: LWSCBasic LWSCFull LWSCEcommerce
39
LWSCAccountName Optional
Account name for this Web Site Creator account. To retrieve this value, use the WSC_GetAllPackages API command. Permitted format is LWSCNNNxNNNN
LWSCWebSiteID
Required
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.
Quantity
Optional; default is 1
Number of years
ClearItems
Optional; you must also add Make all items currently in the cart inactive 3 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.
ResponseType
Optional
3/13/09
Format of response. Options are Text (default), HTML, or XML.
2
4
28
©2003-2009 Register.com, Inc.
API commands: AddToCart
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://partnertest.rcomexpress.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
EndUserIP
Required
End user’s IP address. This is used in fraud checking, as 15 part of our order processing service. Use format NNN.NNN.NNN.NNN.
ProductType
Required
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-VeriSign-Secure-Site Certificate-VeriSign-Secure-Site-Pro Certificate-VeriSign-Secure-Site-EV Certificate-VeriSign-Secure-Site-Pro-EV
Quantity
Required for all certs
Number of years to purchase this cert. Permitted values 2 are 1 to the following maxima: 5 GeoTrust QuickSSL 6 GeoTrust QuickSSL Premium 5 GeoTrust True BusinessID 5 GeoTrust True BusinessID Wildcard 2 GeoTrust True BusinessID with EV 5 RapidSSL 5 VeriSign Secure Site 5 VeriSign Secure Site Pro 2 VeriSign Secure Site with EV 2 VeriSign Secure Site Pro with EV
ClearItems
Optional; you must also add another item to the cart in the same query
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.
ResponseType
Optional
Format of response. Options are Text (default), HTML, 4 or XML.
39
Returned parameters and values Param name Definition ItemName
Domain name or service
ItemId
Item number
Price
Price for this product or service
ICANNFees
Fees charged by ICANN for this product or service
CartItemID
ID number, assigned by us, of this item in your shopping cart
3/13/09
29
©2003-2009 Register.com, Inc.
API commands: AddToCart
Param name Definition ItemAdded
True indicates this entire response has reached you successfully.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query adds partnerdomain.com to the shopping cart of account rcompartnerid and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=addtocart& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&producttype=register& responsetype=xml
The response is as follows: partnerdomain.com 29.95 True ADDTOCART 0 ResellerTest rcom true
Related commands AddBulkDomains DeleteFromCart GetCartContent GetHomeDomainList InsertNewOrder PurchasePreview UpdateCart
3/13/09
30
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligatio Definition n
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
TLDList
Optional; default is *
Comma-delimited list of TLDs to include in search results. Also permitted is *, which returns all TLDs that we offer.
120
SearchCriteria
Optional
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
5
SLD
Optional
String to match in domain name. Use with SearchCriteria to constrain results. For example, SearchCriteria=Start&SLD=A returns all domains that start with A. Permitted values are letters, numbers, and hyphens.
8000
ExcludeNumbers
Optional
1 Return domains with numbers in the domain name? Permitted values are: 0 Exclude domain names containing numbers 1 Include domain names containing numbers
3/13/09
31
©2003-2009 Register.com, Inc.
API commands: AdvancedDomainSearch
Param name
Obligatio Definition n
Max size
ExcludeDashes
Optional
Return domains with hyphens in the domain name? Permitted values are: 0 Exclude domain names containing hyphens 1 Include domain names containing hyphens
1
ParkingStatus
Optional
Return parked domains? Permitted values are: 0 Return domains that are not parked 1 Return domains that are parked
1
RegistrationStatus
Optional
What registration status to return? Permitted values are Registered, Hosted, or Expired
10
AutoRenew
Optional
What auto-renew status to return? Permitted values are: 0 Auto-renew off 1 Auto-renew on
1
Locked
Optional
What registrar lock status to return? Permitted values are: 0 Registrar lock off 1 Registrar lock on
1
CreationDate
Optional
Date the domain was originally registered. Permitted format is MM/DD/YYYY
10
DaysTillExpires
Optional
Return domains that are within this many days 7 of expiration date. Permitted values are integers 0 to 65535
NSStatus
Optional
Return only domains that use our name servers? Permitted values are: Yes No
NameServer
Optional
Return domains that use this name server.
60
HasRCOMShield
Optional
Return domains with RCOM Shield? Permitted values are: 0 Domains with no subscription to RCOM Shield 1 Domains with RCOM Shield
1
DaysUntilRCOMShieldExpires
Optional
Return domains that have RCOM Shield that’s due to expire within the number of days specified here. Permitted values are integers 0 to 65535
7
HasPOPMail
Optional
Return domains with subscriptions to POP mail? Permitted values are: 0 No POP mail subscription 1 Subscribed to POP mail
1
IncludeSubaccounts
Optional
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
SubaccountLogin
Optional
Login name of subaccounts to include
20
OrderBy
Optional
Permitted values are: SLD TLD NSStatus ExpDate Renew
8
3/13/09
5
32
©2003-2009 Register.com, Inc.
API commands: AdvancedDomainSearch
Param name
Obligatio Definition n
Max size
StartPosition
Optional
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.
8
RecordsToReturn
Optional
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.
3
MultiLang
Optional
Permitted values are On or Off.
3
ResponseType
Optional
Format of response. Options are Text (default), 4 HTML, or XML.
Returned parameters and values Param name
Definition
SP-TLDList
Domains included in this return match these TLDs
SP-SLD
Domains included in this return include this character string in the SLD
SP-SearchCriteria
Domains included in this return include the SP-SLD value in this part of the SLD
SP-ParkingStatus
Returned domains match this parking status
SP-XML
XML formatting options for this return
SP-RegistrationStatus
Returned domains match this registration status
SP-AutoRenew
Returned domains match this auto-renew setting
SP-Locked
Returned domains match this registrar lock setting
SP-DaysTillExpires
Returned domains are within this many days of expiration
SP-DaysExpired
Returned domains have expired in the last X days
SP-NSStatus
Returned domains match this name server status
SP-HostRecordType
Not used
SP-HostName
Not used
SP-HostAddress
Not used
SP-NameServer
Returned domains use this name server
SP-HasRCOMShield
Returned domains match this RCOM Shield status
SP-HasPOPMail
Returned domains match this POP mail status
SP-EmailForwarding
Not used
SP-ExcludeNumbers
If SP-ExcludeNumbers=1, returned domains do not contain numbers in the SLD
SP-ExcludeDashes
If SP-ExcludeDashes=1, returned domains do not contain hyphens in the SLD
SP-IncludeSubAccounts
If SP-IncludeSubAccounts=1, returned domains include domains in retail subaccounts
SP-SubAccountLogin
Returned domains are in this subaccount
SP-XMLResponse
XMLResponse setting
SP-RecordsToReturn
This response includes this number of domains in a sorted list
SP-StartPosition
This response starts at this number in the sorted list
SP-OrderBy
Sort criterion for this list
SP-CustomerGroupName
Not used
3/13/09
33
©2003-2009 Register.com, Inc.
API commands: AdvancedDomainSearch
Param name
Definition
TotalResults
Total number of domains that match these search criteria
StartPosition
The first domain in this response is in this position in the overall sorted list of domains
NextPosition
The next response will start at this position in the overall sorted list
MultiRRP
Multiple RRPs in this response?
TLDOverride
TLD override setting
DomainNameID
ID number for this domain
SLD
SLD of this domain
TLD
TLD of this domain
AutoRenew
Auto-renew setting of this domain
ExpDate
Expiration date of this domain
DomainRegistrationStatus
Registration status of this domain
DeleteType
Delete status of this domain
NSStatus
Is this domain using our name servers?
RRProcessor
Registrar credential of this domain name
RRCompanyName
Registrar of record for this domain name
HasRCOMShield
Does this domain have RCOM Shield, and is it enabled?
AbleToReactivate
If expired, can this name be reactivated?
IsPremiumName
Is this a premium .tv name?
PremiumPrice
Price for this premium .tv name
PremiumAboveThresholdPrice
Is the price for this premium .tv name above the premium threshold price?
PremiumCategory
Premium category for a .tv name
ReactivatePrice
Price to reactivate this expired .tv name
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=AdvancedDomainSearch& uid=rcompartnerid&pw=rcompartnerpw&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:
3/13/09
34
©2003-2009 Register.com, Inc.
API commands: AdvancedDomainSearch
r Start Registered 1 1 1 1 ExpDate 5 1 1 False 0 318265980 partnerdomain2 net 0 1/9/2007 Registered rcompartnerid 217-no-0647 NA E Register.com, Inc. disabled . . .
3/13/09
35
©2003-2009 Register.com, Inc.
API commands: AdvancedDomainSearch
152533676 partnerdomain com 1 6/10/2014 Registered rcompartnerid 217-no-0647 NA E Register.com, Inc. disabled ADVANCEDDOMAINSEARCH eng 0 0 10 RESELLER1-STG rcom +0.00 0.438 true
Related commands none
3/13/09
36
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Account login ID
20 20
Required
PW
Required
Account password
TLD
Either TLD or DomainList is Required
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
DomainList
Either TLD or DomainList is Required
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
100
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
37
©2003-2009 Register.com, Inc.
API commands: AuthorizeTLD
Returned parameters and values Param name Definition AuthorizeTLDX
TLD to add to authorized list. Indexed X when ResponseType=Text or HTML.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=authorizetld uid=rcompartnerid&pw=rcompartnerpw&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: com net org AUTHORIZETLD en 0 0 10 RESELLERTEST 0.1523438 true
3/13/09
38
©2003-2009 Register.com, Inc.
API commands: AuthorizeTLD
Related commands GetTLDList PE_SetPricing RemoveTLD SetResellerTLDPricing
3/13/09
39
©2003-2009 Register.com, 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
Definition
AddToCart and InsertNewOrder
Purchase the cert in our system
CertGetCerts
Retrieve the ID number for this cert, to use in configuring it
CertConfigureCert
Obtain information from customer to configure the cert
(this command) CertParseCSR
Parse the CSR
CertGetApproverEmail
Retrieve registrant email address from Registry, for cert approval
CertPurchaseCert
Submit configuration information to certification authority for final issuance of cert
CertModifyOrder (Optional)
Cancel a cert issuance request, so that the cert can be reconfigured
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 partners have access to this command.
Constraints The query must meet the following requirements:
3/13/09
•
The login ID and password must be valid.
•
The cert must belong to this account.
40
©2003-2009 Register.com, Inc.
API commands: CertConfigureCert
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
20
Account login ID
PW
Required
Account password
20
CertID
Required
ID number for this individual certificate. Retrieve this number using the CertGetCerts command.
8
WebServerType
Required
Type of product to add. Permitted values are: 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 O’Reilly WebSite Professional 32 WebStar 33 Microsoft IIS 6.0
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 VeriSign certs
3/13/09
41
©2003-2009 Register.com, Inc.
API commands: CertConfigureCert
Param name
Obligation Definition
ContactTypeFName
Optional overall—the default for a cert Admin is the Admin contact for this account; defaults for the cert Tech and Billing contacts are the cert Admin contact. If you supply information for a ContactType, this param is Required
ContactTypeLName
If you supply Family name of this ContactType for this information cert. For example, AdminLName=Doe for a ContactType, this param is Required
ContactTypeOrgName
If you supply Organization name of this ContactType for 60 this cert information for a ContactType, this param is Optional
ContactTypeJobTitle
If you supply Job title of this ContactType for this cert information for a ContactType, this param is Optional
60
ContactTypeAddress1
If you supply Address, line 1, of this ContactType for this cert information for a ContactType, this param is Required
60
ContactTypeAddress2
If you supply Address, line 2, of this ContactType for information this cert for a ContactType, this param is Optional
60
ContactTypeCity
If you supply City for this ContactType for this cert information for a ContactType, this param is Required
60
3/13/09
Given name of this ContactType for this cert. Permitted ContactTypes are Admin, Tech, and Billing. For example, AdminFName=John
Max size 60
60
42
©2003-2009 Register.com, Inc.
API commands: CertConfigureCert
Param name
Obligation Definition
Max size
ContactTypeState
Either State or Province is Required for each ContactType
State for this ContactType for this cert
2
ContactTypeProvince
Either State or Province is Required for each ContactType
Province for this ContactType for this cert
60
Is this cert ContactType’s location a state or province? Permitted values are: S state P province
1
ContactTypeStateProvinceChoice If you supply information for a ContactType, this param is Optional ContactTypePostalCode
If you supply Postal code for this ContactType for this cert information for a ContactType, this param is Required
16
ContactTypeCountry
If you supply Country for this ContactType for this cert, information in two-letter country code format for a ContactType, this param is Required
2
ContactTypePhone
If you supply information for a ContactType, this param is Required
ContactTypePhoneExt
If you supply Phone extension for this this ContactType information for this cert for a ContactType, this param is Optional
ContactTypeFax
If you supply information for a ContactType, this param is Optional
ContactTypeEmailAddress
If you supply Email address for this ContactType for this 128 information cert. Use format for a
[email protected] ContactType, this param is Required
ResponseType
Optional
3/13/09
Phone for this this ContactType for this cert. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
Fax number for this ContactType for this cert. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
Format of response. Options are Text (default), HTML, or XML.
17
8
17
4
43
©2003-2009 Register.com, Inc.
API commands: CertConfigureCert
Returned parameters and values Param name
Definition
CertID
Identification number of this individual cert
Success
Has this cert been configured successfully?
Organization
Organization embedded in this CSR
DomainName
Domain name embedded in this CSR
Email
Email addresss embedded in this CSR
HasBadExtensions
Any bad extensions?
IsValidQuickDomainName
Valid quick domain name?
IsValidTrueDomainName
Valid true domain name?
Locality
Locality embedded in this CSR
OrganizationUnit
Organization unit embedded in this CSR
State
State embedded in this CSR
Country
Country embedded in this CSR
ApproverType
Type of this approver
ApproverEmail
Email address of this approver
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
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://partnertest.rcomexpress.com/ interface.asp?command=CERTCONFIGURECERT&uid=rcompartnerid&pw=rcompartnerpw&ResponseTy pe=XML&CertID=289&Action=Configure&WebServerType=2&CSR=MIIDPjCCAqcCAQAwYzEYMBYGA1U EAxMPa2ltYmVybHlzaGluLnVzMQwwCgYDVQQLEwNLaW0xDDAKBgNVBAoTA0tpbTERMA8GA1UEBxMIQ mVsbGV2dWUxCzAJBgNVBAgTAldBMQswCQYDVQQGEwJVUzCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgY kCgYEA0gTzzYfBzisSajyZsb0wXPog%2FpHlmYZp5v7ta5LbgSQ0XbLGGXU7KYwrhFZqZ1pgboflWgYSEM %2BVwYc%2B0AZHd5yeAZKFN08GhTQxgaV0oiK3Q1Nj4pNVsju%2B7uwiBI9v8S6Gyowa7LF4ZKcUWd HSX6e4%2Fgcgd1N%2FdWWQmzfpKisCAwEAAaCCAZkwGgYKKwYBBAGCNw0CAzEMFgo1LjAuMjE5NS 4yMHsGCisGAQQBgjcCAQ4xbTBrMA4GA1UdDwEB%2FwQEAwIE8DBEBgkqhkiG9w0BCQ8ENzA1MA4GC CqGSIb3DQMCAgIAgDAOBggqhkiG9w0DBAICAIAwBwYFKw4DAgcwCgYIKoZIhvcNAwcwEwYDVR0lBAw wCgYIKwYBBQUHAwEwgf0GCisGAQQBgjcNAgIxge4wgesCAQEeWgBNAGkAYwByAG8AcwBvAGYAdAAgA FIAUwBBACAAUwBDAGgAYQBuAG4AZQBsACAAQwByAHkAcAB0AG8AZwByAGEAcABoAGkAYwAgAFAAc gBvAHYAaQBkAGUAcgOBiQAnUv2qmJCagvl02VUuQzY%2FpQVwxgwTVxQyJ08RQcQZ%2FE4HV5MZe7 yuGC4l8NJxSLL2HVI6Qc7wKeMJAWhg%2BFv%2BJGFoJtu7VSw1%2BgkbWKYI%2FTsuvyTyA5bvrO6%
3/13/09
44
©2003-2009 Register.com, Inc.
API commands: CertConfigureCert
2Bf7N9TkBtJCMl%2F9JtfItk71MNt7hjZqSVGjZp5kFWbYZfPd7ONgAAAAAAAAAAMA0GCSqGSIb3DQEBB QUAA4GBAGvhsjZbtidJL48NqJecna5A0eIwGiizlYjJibLcdN6YnR%2BMN4BP8JmX8T2CJPnHOf2PIeXUujLh zv5bajXvHVTy1oG%2B%2FYLc%2B3LQzSm9rQXjMEk%2F1eJXi3OAShQX%2BS2GbyaUitu%2BlZ%2FK 8QIzxCtoKf0vNlzbB70fOjWWQqfJhVsm&AdminOrgName=Bel+Air&AdminJobTitle=Pres&AdminFName =F&AdminLName=Bern&AdminAddress1=516+Apple&AdminCity=Bel+Air&AdminState=MD&AdminPo stalCode=21014&AdminCountry=US&AdminPhone=5555555555&AdminEmailAddress=john@partnerd omain.com&TechOrgName=Bel+Air&TechJobTitle=Pres&TechFName=F&TechLName=Bern&TechAddres s1=516+Apple&TechCity=Bel+Air&TechState=MD&TechPostalCode=21014&TechCountry=US&TechPho
[email protected]&BillingOrgName=Bel+Air&BillingJobTi tle=Pres&BillingFName=F&BillingLName=Bern&BillingAddress1=516+Apple&BillingCity=Bel+Air&Billin gState=MD&BillingPostalCode=21014&BillingCountry=US&BillingPhone=5555555555&BillingEmailAddress=john@partnerdomain.com
In the response, a success value True confirms that the query was successful: 289 True Acme partnerdomain.com false true true Townsville Sales NY US True
[email protected] [email protected] [email protected] . . . CERTCONFIGURECERT en 0 0 10 LOCALHOST rcom +0.00 1.328125 true
3/13/09
45
©2003-2009 Register.com, Inc.
API commands: CertConfigureCert
Related commands CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert GetCerts
3/13/09
46
©2003-2009 Register.com, 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
Definition
AddToCart and InsertNewOrder
Purchase the cert in our system
CertGetCerts
Retrieve the ID number for this cert, to use in configuring it
CertConfigureCert
Obtain information from customer to configure the cert
CertParseCSR
Parse the CSR
CertGetApproverEmail
Retrieve registrant email address from Registry, for cert approval
(this command) CertPurchaseCert
Submit configuration information to certification authority for final issuance of cert
CertModifyOrder (Optional)
Cancel a cert issuance request, so that the cert can be reconfigured
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Account login ID
20
3/13/09
Required
47
©2003-2009 Register.com, Inc.
API commands: CertGetApproverEmail
Param name Obligation
Definition
Max size
PW
Required
Account password
20
Domain
Required
Domain name that is associated with this cert, in format sld.tld. Use CertParseCSR or CertGetCertDetail to retrieve this value.
79
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Success
Success status for retrieving the authoritative Whois registrant email
ApproverType
Type of approver
ApproverEmail
Email address of approver
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 registrant’s email address, generates other email addresses that are likely to be valid approvers for the cert, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=CertGetApproverEmail& uid=rcompartnerid&pw=rcompartnerpw&Domain=partnerdomain.com&ResponseType=XML
In the response, a Success status True confirms that the query was successful: True
[email protected] [email protected] [email protected] [email protected]
3/13/09
48
©2003-2009 Register.com, Inc.
API commands: CertGetApproverEmail
[email protected] [email protected] [email protected] [email protected] CERTGETAPPROVEREMAIL en 0 0 10 LOCALHOST rcom +0.00 0.75 true
Related commands CertConfigureCert CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert GetCerts
3/13/09
49
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
CertID
Required
ID number of this cert. Use the CertGetCerts command to retrieve the ID number
8
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
CertID
ID number of this individual cert
DomainName
Domain this cert is associated with
ValidityPeriod
Total validity duration of this cert, in months
OrderDate
Date on which this cert was ordered
ConfigDate
Date on which this cert was installed
RenewalIndicator
Renewal indicator setting for this cert
WebServerTypeID
ID number of the type of server this cert is configured for
3/13/09
50
©2003-2009 Register.com, Inc.
API commands: CertGetCertDetail
Param name
Definition
WebServerTypeName
Text description of the type of server this cert is configured for
OrderID
ID number of the order that included this cert
OrderDetailID
Item ID number of this cert when it was ordered
ExpirationDate
Expiration date of this cert
ServerCount
Should always be 1
ApproverEmail
Email address of the registrant
Message
Message
CertStatusID
ID number that identifies this cert’s phase in its processing
CertStatus
Text description of this cert’s status in its processing
ProdType
Product ID number of this type of cert
ProdDesc
Text description of this type of cert
CSR
Certificate Signing Request (CSR) code, provided by the certificate authority
ReferenceID
Reference ID number for this cert
SSLCertificate
SSL certificate, provided by the certificate authority.
ContactTypeOrgName
Organization name of Admin, Tech, or Billing Contact
ContactTypeJobTitle
Job title of Contact
ContactTypeFName
Given name of Contact
ContactTypeLName
Family name of Contact
ContactTypeAddress1
Contact address, first line
ContactTypeAddress2
Contact address, second line
ContactTypeCity
Contact city
ContactTypeStateProvince
Contact state or province
ContactTypeStateProvinceChoice Is this a state or a province? ContactTypePostalCode
Contact postal code
ContactTypeCountry
Contact country
ContactTypePhone
Contact phone
ContactTypeFax
Contact fax
ContactTypeEmailAddress
Contact email address
ContactTypePhoneExt
Contact phone extension
WebServerTypeID
ID number of this type of Web server
WebServerTypeName
Text description of this type of Web server
WebServerTypeCode
Text abbreviation of this type of Web server
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
3/13/09
51
©2003-2009 Register.com, Inc.
API commands: CertGetCertDetail
Example The following query retrieves information on a cert, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=CERTGETCERTDETAIL& uid=rcompartnerid&pw=rcompartnerpw&CertID=288&ResponseType=XML
In the response, cert information and an ErrCount value 0 confirm that the query was successful: 288 partnerdomain.com 12 2/14/2005 11:23:59 AM False 13 Microsoft IIS 5.0 156249495 1372870 2/14/2006 11:23:59 AM 1
[email protected] 2 Processing 21 SSL Certificate - GeoTrust True BusinessID -----BEGIN NEW CERTIFICATE REQUEST----MIIDPjCCAqcCAQAwYzEYMBYGA1UEAxMPa2ltYmVybHlzaGluLnVzMQwwCgY DVQQLEwNLaW0xDDAKBgNVBAoTA0tpbTERMA8GA1UEBxMIQmVsbGV2dWUxCzA JBgNVBAgTAldBMQswCQYDVQQGEwJVUzCBnzANBgkqhkiG9w0BAQEFAAOBjQAw . . . 4BP8JmX8T2CJPnHOf2PIeXUujLhzv5bajXv HVTy1oG+/YLc+3LQzSm9rQXjMEk/1e JXi3OAShQX+S2GbyaUitu+lZ/K8QIzxCto Kf0vNlzbB70fOjWWQqfJhVsm -----END NEW CERTIFICATE REQUEST----- 17554 >-----BEGIN CERTIFICATE----MIIDRTCCAq6gAwIBAgIDBPEKMA0GCSqGSIb3DQEBBAUAMFoxCzAJBgNVBAYTAlVT MRwwGgYDVQQKExNFcXVpZmF4IFNlY3VyZSBJbmMuMS0wKwYDVQQDEyRFcXVpZm F4IFNlY3VyZSBHbG9iYWwgZUJ1c2luZXNzIENBLTEwHhcNMDYxMTEzMjIxNDA4WhcN . . . uJeFstXuC8vlHNiDbfiuVB3avYCKOChvRBcrZmiS907yPjIUbaJ0GtCXkp+uLyje Y29RJJlU0XN527CE5P3Vh6Oaok5J6cr2tJMwAJS+t9obF8yDR9NHSU+9wcz5nS6V zRpH7lZ2TDtq6+NT7EA3m5D3vvMI9ESDpw== -----END CERTIFICATE---- Partner Domains Inc. Tester John Doe 100 Main Street Hometown 99999
3/13/09
52
©2003-2009 Register.com, Inc.
API commands: CertGetCertDetail
US 5559995555 none
[email protected] Partner Domains Inc. . . . Partner Domains Inc. . . . 1 Apache + MOD SSL apachessl 20 Apache + OpenSSL apacheopenssl 2 Apache + Raven apacheraven . . . CERTGETCERTDETAIL en 0 0 10 LOCALHOST rcom +0.00 0.1914063 true
Related commands CertConfigureCert CertGetApproverEmail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert GetCerts
3/13/09
53
©2003-2009 Register.com, 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
Definition
AddToCart and InsertNewOrder
Purchase the cert in our system
CertGetCerts
Retrieve the ID number for this cert, to use in configuring it
(this command) CertConfigureCert
Obtain information from customer to configure the cert
CertParseCSR
Parse the CSR
CertGetApproverEmail
Retrieve registrant email address from Registry, for cert approval
CertPurchaseCert
Submit configuration information to certification authority for final issuance of cert
CertModifyOrder (Optional)
Cancel a cert issuance request, so that the cert can be reconfigured
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
54
©2003-2009 Register.com, Inc.
API commands: CertGetCerts
Returned parameters and values Param name
Definition
IsExpired
Is this cert expired?
CertID
ID number for this individual cert, from our database
OrderDate
Date on which this cert was purchased
ConfigDate
Date on which this cert was configured
DomainName
Domain that this cert is associated with
ValidityPeriod
Expiration date for this cert
RenewalIndicator
Renewal indicator setting
ProdType
Product ID number, from our records
ProdDesc
Text description of product
ExpirationDate
Expiration date of this cert
ServerCount
Should always return 1
CertStatus
Current status of this cert
CertStatusID
ID number corresponding to current cert status
OrderID
Identification number of the order that included this cert
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query retrieves all certs in a domain name account, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=CertGetcerts& UID=rcompartnerid&PW=rcompartnerpw&ResponseType=XML
In the response, cert information and the ErrCount value 0 confirm that the query was successful: False 233 3/21/2007 12 False 26
3/13/09
55
©2003-2009 Register.com, Inc.
API commands: CertGetCerts
SSL Certificate - GeoTrust QuickSSL 3/21/2008 1 Awaiting Configuration 1 157404629 False 208 2/14/2007 partnerdomain.com 12 False 21 SSL Certificate - GeoTrust True BusinessID 2/14/2008 1 Processing 2 157402737 . . . CERTGETCERTS en 0 0 10 RESELLERTEST rcom +0.00 0.1523438 true
Related commands CertConfigureCert CertGetApproverEmail CertGetCertDetail CertModifyOrder CertParseCSR CertPurchaseCert GetCerts
3/13/09
56
©2003-2009 Register.com, 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 customer’s 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
Definition
AddToCart and InsertNewOrder
Purchase the cert in our system
CertGetCerts
Retrieve the ID number for this cert, to use in configuring it
CertConfigureCert
Obtain information from customer to configure the cert
CertParseCSR
Parse the CSR
CertGetApproverEmail
Retrieve registrant email address from Registry, for cert approval
CertPurchaseCert
Submit configuration information to certification authority for final issuance of cert
CertModifyOrder (Optional)
Cancel a cert issuance request, so that the cert can be reconfigured
(this command)
Availability All partners have access to this command.
Constraints The query must meet the following requirements:
3/13/09
•
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.
57
©2003-2009 Register.com, Inc.
API commands: CertModifyOrder
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
CertID
Required
ID number for this cert, from our records. Use the CertGetCerts command to retrieve this number.
6
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition CertID
Identification number of this cert
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=CertModifyOrder& uid=rcompartnerid&pw=rcompartnerpw&CertID=294&ResponseType=XML
In the response, a cert ID number and an ErrCount value 0 confirms that the query was successful: 294 CERTMODIFYORDER en 0 0 10
3/13/09
58
©2003-2009 Register.com, Inc.
API commands: CertModifyOrder
LOCALHOST rcom +0.00 0.109375 true
Related commands CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertParseCSR CertPurchaseCert GetCerts
3/13/09
59
©2003-2009 Register.com, 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
Definition
AddToCart and InsertNewOrder
Purchase the cert in our system
CertGetCerts
Retrieve the ID number for this cert, to use in configuring it
CertConfigureCert
Obtain information from customer to configure the cert
CertParseCSR
Parse the CSR
(this command) CertGetApproverEmail
Retrieve registrant email address from Registry, for cert approval
CertPurchaseCert
Submit configuration information to certification authority for final issuance of cert
CertModifyOrder (Optional)
Cancel a cert issuance request, so that the cert can be reconfigured
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
3/13/09
60
©2003-2009 Register.com, Inc.
API commands: CertParseCSR
Param name Obligation
Definition
Max size
CSR
Required
Certificate Signing Request (CSR) generated as an input parameter for the CertConfigureCert command.
4500
CertID
Required
ID number of this cert. To retrieve this number, use the CertGetCerts command.
8
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
Success
Success status of this parsing operation
Organization
Organization name embedded in the CSR
DomainName
Domain name embedded in the CSR
Email
Email address embedded in the CSR
Locality
Locality (usually a city) embedded in the CSR
OrganizationUnit
Organizational unit embedded in the CSR
State
State embedded in the CSR
Country
Country embedded in the CSR
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=CertParseCSR& uid=rcompartnerid&pw=rcompartnerpw&ResponseType=XML&CertID=295& CSR=%2D%2D%2D%2D%2DBEGIN+NEW+CERTIFICATE+REQUEST%2D%2D%2D%2D%2D%0D%0 AMIIDVzCCAsACAQAwfDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkRFMRMwEQYDVQQH%0D%0AEwp 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
3/13/09
61
©2003-2009 Register.com, Inc.
API commands: CertParseCSR
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: True Acme Inc. www.partnerdomain.com Wilmington SSL Certificate DE US CERTPARSECSR en 0 0 10 LOCALHOST rcom +0.00 0.578125 true
Related commands CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertPurchaseCert GetCerts
3/13/09
62
©2003-2009 Register.com, 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
Definition
AddToCart and InsertNewOrder
Purchase the cert in our system
CertGetCerts
Retrieve the ID number for this cert, to use in configuring it
CertConfigureCert
Obtain information from customer to configure the cert
CertParseCSR
Parse the CSR
CertGetApproverEmail
Retrieve registrant email address from Registry, for cert approval
CertPurchaseCert (this command)
Submit configuration information to certification authority for final issuance of cert
CertModifyOrder (Optional)
Cancel a cert issuance request, so that the cert can be reconfigured
Availability All partners have access to this command.
Constraints The query must meet the following requirements:
3/13/09
•
The login ID and password must be valid.
•
The cert must belong to this account.
63
©2003-2009 Register.com, Inc.
API commands: CertPurchaseCert
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ApproverEmail
Required
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 registrant’s email address (the “approver”) from the authoritative Whois database.
130
CertID
Required
ID number for this cert, from our records. Use the CertGetCerts command to retrieve this number.
6
CSROrganization
Optional for EV Name of the organization that will use this cert certs
CSROrganizationUnit Optional for EV Unit within the organization that will use this cert certs
64 64
CSRAddress1
Optional for EV Address, line 1, of the organization that will use this 128 certs cert
CSRAddress2
Optional for EV Address, line 2 certs
128
CSRAddress3
Optional for EV Address, line 3 certs
128
CSRLocality
Optional for EV Location (often a city) of the organization certs
128
CSRStateProvince
Optional for EV State or province in which the organization is certs located
128
CSRPostalCode
Optional for EV Postal code of the organization certs
40
CSRCountry
Optional for EV Country in which the organization is located certs
40
DUNSNumber
Optional for EV D-U-N-S Number. Speeds validation of EV certs certs
32
ResponseType
Optional
4
Format of response. Options are Text (default), HTML, or XML.
Returned parameters and values Param name Definition CertID
Identification number of this cert
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
64
©2003-2009 Register.com, 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://partnertest.rcomexpress.com/interface.asp?command=CertPurchaseCert& uid=rcompartnerid&pw=rcompartnerpw&ApproverEmail=johndoe@partnerdomain.com&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: 295 CERTPURCHASECERT en 0 0 10 LOCALHOST rcom +0.00 0.71875 true
Related commands CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR GetCerts
3/13/09
65
©2003-2009 Register.com, Inc.
API commands: Check
Check Description Definition Check the availability of a domain name.
Usage Use this command to check whether a domain name is already registered.
Availability The Check command is available to every reseller.
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.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?Command=Check&UID=YourLogin &PW=YourPassword&SLD=DesiredSLD&TLD=DesiredTLD&OptParam1=ParamValue1 &OptParam2=ParamValue2
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required unless DomainList is used
Second-level domain name (for example, register in register.com)
63
3/13/09
66
©2003-2009 Register.com, Inc.
API commands: Check
Param name Obligation Definition
Max size
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
15
DomainList
Optional
A comma- or newline-delimited list of domains to check, up to 30 names. If used, SLD and TLD are ignored.
2000
TLDList
Optional
A comma- or newline-delimited list of TLDs to check, up to 30 names. If used, TLD is ignored.
2000
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DomainX
If return includes multiple domains, the name of domain X (indexed X in HTML and Text output, but not in XML output)
RRPCodeX
Success code. Only 210 indicates that the name is available at the Registry. 211 indicates the domain is not available at the Registry.
RRPTextX
Text which accompanies and describes the RRPCode. 210 Domain available 211 Domain not available
IsPremiumName
True indicates this is a premium name.
PremiumPrice
Registration price per year for this premium name, in $US.
PremiumAboveThresholdPrice True indicates the registration price for this premium name is higher than for non-premium names. AuctionDateX
Scheduled closing date for this auction
AuctionIDX
Auction ID number for this domain name
DomainCount
The number of names checked.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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.
3/13/09
67
©2003-2009 Register.com, Inc.
API commands: Check
Example The following checks whether the domain name unusualTVname.tv is available and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=check& sld=unusualTVname&tld=tv&responsetype=xml
The response indicates that unusualTVname.tv is available: unusualtvname.tv False False 210 Domain available CHECK eng 0 0 1 10 Reseller4 rcom True True +03.00 0.172 true
Related commands AddBulkDomains InsertNewOrder NameSpinner Purchase
3/13/09
68
©2003-2009 Register.com, Inc.
API commands: CheckLogin
CheckLogin Description Definition Validate user login for a domain name.
Usage Use this command when you want to validate a user’s identity.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?Command=CheckLogin&UID=YourLogin &PW=YourPassword
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
PartyID
PartyID of the account
Reseller
Is this a reseller account?
ParentAccount
Parent account ID number
RSA
Reserved parameter. Should always return False.
SiteType
Site
HelpEmailAddress
Email address for the Billing contact for this account
Type
Agreement type
Description
Name of this agreement
Category
Category of this agreement
RemoteURL
URL of this agreement, if it is not served by us
3/13/09
69
©2003-2009 Register.com, Inc.
API commands: CheckLogin
Param name
Definition
LatestVersion
Version number of this agreement
Agreed
Has this account agreed to this agreement?
CurrentCompliance
Is this account currently complying with this agreement?
AgreementNote
Note on this agreement
ParentAccount
Account ID of this account’s parent
Enforced
Enforcement setting
ViewAgreement
View setting for agreement
CartItems
Number of items currently in cart
Command
Name of command executed
Language
Language setting
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
ResponseCount
Number of responses
MinPeriod
Minimum registration period (for domain names)
MaxPeriod
Maximum registration period (for domain names)
Server
Server name
Site
Site for which this response is configured
IsLockable
Can this domain be Registrar locked? (for domain names)
IsRealTimeTLD
Is this a domain that can be purchased in real time? (for domain names)
TimeDifference
Time difference between this site and our servers
ExecTime
Time elapsed to execute this command
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query requests the party ID and reseller status of account rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=checklogin& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response provides basic information about the account: {BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629} True 000-00-0000 1 False E
[email protected]
3/13/09
70
©2003-2009 Register.com, Inc.
API commands: CheckLogin
1 ResellerAgreement ResellerAgreement 2.4 0 1 4 ResellerNotification ResellerNotification 12 1 1 000-00-0000 False True 3 CHECKLOGIN eng 0 0 10 RESELLER1-STG rcom +0.00 0.266 true
Related commands CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory UpdateAccountInfo UpdateCusPreferences
3/13/09
71
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
CheckNSName
Required
Name server use name to check. Use format dnsX.NameServerName.com.
63
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
NSCheckSuccess
Was this name server check successful? 1 indicates yes; 0 indicates no.
Other parameters
Other parameters will be returned, and will vary from one name server to another
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
72
©2003-2009 Register.com, Inc.
API commands: CheckNSStatus
Param name
Definition
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 dns01.gpn.register.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=checknsstatus& uid=rcompartnerid&pw=rcompartnerpw&checknsname=dns01.gpn.register.com& responsetype=xml
The NsCheckStatus value of 1 indicates that the name server was found: 1 0 dns01.gpn.register.com ok linked 63.251.83.37 5232127_HOST_CNE-VRSN 2002-01-15T20:34:07.0000Z 2002-04-18T17:35:43.0000Z y2ktest rccbatch 024 CHECKNSSTATUS eng 0 0 10 RESELLER1-STG rcom +0.00 1.125 true
3/13/09
73
©2003-2009 Register.com, Inc.
API commands: CheckNSStatus
Related commands DeleteNameServer GetDNS GetDNSStatus ModifyNS ModifyNSHosting RegisterNameServer UpdateNameServer
3/13/09
74
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
75
©2003-2009 Register.com, 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 rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=commissionaccount& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response lists the balances: 6.69 0 COMMISSIONACCOUNT 0 ResellerTest rcom true
Related commands GetBalance PE_GetCustomerPricing PE_GetDomainPricing PE_GetResellerPrice PE_GetRetailPrice PE_SetPricing
3/13/09
76
©2003-2009 Register.com, 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 partners have access to this 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 don’t use the ContactType parameter and don’t supply new information for all contacts, those that you don’t supply will be empty in the database and will use our defaults in interfaces.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20 20
PW
Required
Account password
SLD
Required
Second-level domain name (for 63 example, register in register.com)
TLD
Required
Top-level domain name (extension)
3/13/09
15
77
©2003-2009 Register.com, Inc.
API commands: Contacts
Param name
Obligation
Definition
Max size
ContactType
Optional
Type of contact to add/update. Options are REGISTRANT, AUXBILLING, TECH, ADMIN
16
ContactTypeOrganizationName
Required for each contact type you add or update
Organization of ContactType contact
60
ContactTypeFirstName
Required for each contact type you add or update
First name of ContactType contact
60
ContactTypeLastName
Required for each contact type you add or update
Last name of ContactType contact 60
ContactTypeJobTitle
Optional
Job title of ContactType contact
60
ContactTypeAddress1
Required for each contact type you add or update
Address of ContactType contact
60
ContactTypeAddress2
Optional
Additional address info of ContactType contact
60
ContactTypeCity
Required for each contact type you add or update
City of ContactType contact
60
ContactTypeStateProvinceChoice Optional
State or province choice of ContactType contact. Permitted values are: S State P Province
1
ContactTypeStateProvince
Optional
State or province of ContactType contact
60
ContactTypePostalCode
Optional for most TLDs; Required for .org
Postal code of ContactType contact
16
ContactTypeCountry
Required for each contact type you add or update
Country of ContactType contact
60
ContactTypeEmailAddress
Required for each contact type you add or update
Email address of ContactType contact
128
ContactTypePhone
Required for each contact type you add or update
Phone number of ContactType contact. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
17
ContactTypePhoneExt
Optional for each contact type you add or update
Phone extension of ContactType contact
17
3/13/09
78
©2003-2009 Register.com, Inc.
API commands: Contacts
Param name
Obligation
Definition
Max size
ContactTypeFax
Optional
Fax number of ContactType contact. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
17
ExtendedAttributes
Required for some country codes
Data required by the Registry for some country codes. Use GetExtAttributes to determine whether this TLD requires extended attributes.
varies
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The 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 don’t use the ContactType parameter and don’t supply new information for all contacts, those that you don’t supply will be empty in the database and will use our defaults in interfaces.
•
AUXBILLING masks the true billing contact in WhoIs output.
•
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.
3/13/09
79
©2003-2009 Register.com, Inc.
API commands: Contacts
Example The following query provides new technical contact information for partnerdomain.com and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=contacts& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com& ContactType=Tech&TechFirstName=John&TechLastName=Smith& TechPhone=+1.5555555555&TechAddress1=100%20Main%20St.&TechCity=Townsville&
[email protected]&responsetype=xml
The error count of 0 in the response confirms that the query was successful: E False CONTACTS 0 RESELLERTEST rcom True True true
Related commands AddContact GetAddressBook GetContacts GetExtAttributes GetServiceContact GetWhoisContact Preconfigure
3/13/09
80
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
NewUID
Required
Subaccount login ID. Permitted characters are letters, numbers, hyphen, and underscore
20
NewPW
Required
Subaccount password. Permitted characters are letters, numbers, hyphen, and underscore
20
ConfirmPW
Required
Confirm subaccount password. Permitted characters are letters, numbers, hyphen, and underscore
20
RegistrantOrganizationName
Required
Registrant organization
60
RegistrantJobTitle
Optional
Registrant job title
60
RegistrantFirstName
Required
Registrant first name
60
RegistrantLastName
Required
Registrant last name
60
RegistrantAddress1
Required
Registrant address
60
RegistrantAddress2
Optional
Registrant additional address info
60
RegistrantCity
Required
Registrant city
60
RegistrantPostalCode
Required
Registrant postal code
16
3/13/09
81
©2003-2009 Register.com, Inc.
API commands: CreateAccount
Param name
Obligation
Definition
Max size
RegistrantStateProvince
Optional
Registrant state or province
60
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: S state P province
1
RegistrantCountry
Optional
Registrant country
60
RegistrantPhone
Required
Registrant phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
17
RegistrantFax
Optional
Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
17
RegistrantEmailAddress
Required
Email address for Whois
128
RegistrantEmailAddress_Contact
Optional
Email address for us to contact you about your domain name account
128
CardType
Required
Type of credit card
20
CCName
Required
Cardholder's name
60
CreditCardNumber
Required
Customer's credit card number
128
CreditCardExpMonth
Required
Credit card expiration month
2
CreditCardExpYear
Required
Credit card expiration year
4
CVV2
Required
Credit card verification code
4
CCAddress
Required
Credit card billing address
60
CCZip
Required
Credit card billing postal code
15
CCCountry
Required
Credit card billing country
60
AuthQuestionType
Required
Type of question. Values can be smaiden, sbirth, ssocial, shigh
10
AuthQuestionAnswer
Required
The answer to the question type (mother's maiden name, city of birth, last 4 digits of social security, or high school)
50
EmailInfo
Optional
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
10
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
OrganizationName
Organization name of the Billing contact
FName
First name (given name) of the Billing contact
LName
Last name (family name) of the Billing contact
JobTitle
Job title for the Billing contact
3/13/09
82
©2003-2009 Register.com, Inc.
API commands: CreateAccount
Param name
Definition
Address1
Address, line 1, for the Billing contact
Address2
Address, line 2, for the Billing contact
City
City for the Billing contact
StateProvince
State or province for the Billing contact
StateProvinceChoice
Tells whether StateProvince value is a state or a province
PostalCode
Postal code for the Billing contact
Country
County for the Billing contact
Phone
Phone number for the Billing contact
PhoneExt
Phone extension for the Billing contact
Fax
Fax number for the Billing contact
EmailAddress
Email address for public WhoIs record
EmailAddress_Contact Email address that we use when contacting account owner about this account EmailInfo
Tells whether confirmation emails should be sent to these email addresses
CCType
Type of credit card
CCName
Cardholder’s name
CCNumber
Credit card number
CCMonth
Expiration month for this credit card
CCYear
Expiration year for this credit card
CCAddress
Billing address street address for this credit card
CCCity
Billing address city for this credit card
CCStateProvince
Billing address state or province for this credit card
CCZip
Billing address postal code for this credit card
CCCountry
Billing address country for this credit card
CCPhone
Phone number on record for this credit card
Reseller
1 indicates this subaccount is a reseller account; 0 indicates retail
NewUID
Login ID for this subaccount
NewPW
Password for this subaccount
ConfirmPW
Repeat password, for confirmation purposes
AuthQuestionType
Type of authorization question for this subaccount
AuthQuestionAnswer
Answer to the authorization question
DefPeriod
Default registration period for domain names, in years
StatusCustomerInfo
Returns Successful if the subaccount was created
PartyID
Party ID of this subaccount, for our records
Account
Account ID code of this subaccount, for our records. We recommend that you store this value.
sLoginPass
Code we use to log the user into the new subaccount immediately.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
83
©2003-2009 Register.com, Inc.
API commands: CreateAccount
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 giambi, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=CreateAccount& uid=rcompartnerid&pw=rcompartnerpw&NewUID=giambi& NewPW=giambipw&ConfirmPW=giambipw& 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%40partnerdomain%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: Successful {8D504DD5-C773-41C4-83F6-4495CA479103} 154-dz-5567 91DDFEF7E0E7F6A9DDFEF7E0E7F6A9A5BDA0A6BDA0A2A2A0B2A5A8A2A3A8A2AAB2C2DF
CREATEACCOUNT 0 ResellerTest rcom true
3/13/09
84
©2003-2009 Register.com, Inc.
API commands: CreateAccount
Related commands CheckLogin CreateSubAccount DeleteSubaccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory SubAccountDomains UpdateAccountInfo UpdateCusPreferences
3/13/09
85
©2003-2009 Register.com, 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. CreateSubAccount differs from CreateAccount in that CreateAccount offers credit card processing; CreateSubAccount does not.
Availability All partners have access to this command.
Constraints The query must meet the following requirements: •
The account must have reseller status in Register.com’s database.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20 20
PW
Required
Account password
NewUID
Required
Subaccount login ID. Permitted 20 characters are letters, numbers, hyphen, and underscore
NewPW
Required
20 Subaccount password. Permitted characters are letters, numbers, hyphen, and underscore
ConfirmPW
Required
Confirm subaccount password. Permitted characters are letters, numbers, hyphen, and underscore
20
AuthQuestionType
Optional
Type of question. Values can be smaiden, sbirth, ssocial, shigh
10
AuthQuestionAnswer
Optional
The answer to the question type (mother's maiden name, city of birth, last 4 digits of social security, or high school)
50
RegistrantAddress1
Required
Registrant address
60
3/13/09
86
©2003-2009 Register.com, Inc.
API commands: CreateSubAccount
Param name
Obligation Definition
Max size
RegistrantAddress2
Optional
Registrant additional address info
60
RegistrantCity
Required
Registrant city
60
RegistrantCountry
Required
Registrant country
60
RegistrantEmailAddress
Required
Email address for WhoIs
128
RegistrantEmailAddress_Contact
Optional
Email address for us to contact you about your domain name account
128
RegistrantFax
Optional
Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
17
RegistrantFirstName
Required
Registrant first name
60
RegistrantLastName
Required
Registrant last name
60
RegistrantJobTitle
Optional
Registrant job title
60
RegistrantOrganizationName
Optional
Registrant organization
60
RegistrantPhone
Required
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
17
RegistrantPostalCode
Optional
Registrant postal code
16
RegistrantStateProvince
Optional
Registrant state or province
60
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: S state P province
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
StatusCustomerInfo
Returns Successful if account was created
PartyID
Party ID for the new subaccount
Account
Account ID for the new subaccount
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
3/13/09
87
©2003-2009 Register.com, Inc.
API commands: CreateSubAccount
Example The following query creates a new subaccount, resellsub4, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=CreateSubAccount& uid=rcompartnerid&pw=rcompartnerpw&newuid=resellsub4&newpw=resellsub4& confirmpw=resellsub4&RegistrantOrganizationName=Reseller%20Documents%20Inc.& RegistrantFirstName=john&RegistrantLastName=doe&RegistrantAddress1=111%20Main%20St.& RegistrantCity=Hometown&RegistrantStateProvince=NY&RegistrantStateProvinceChoice=S& RegistrantPostalCode=98003&RegistrantCountry=United+States& RegistrantEmailAddress=john%2Edoe%40partnerdomain%2Ecom& RegistrantPhone=+1.5555555555&RegistrantFax=+1.5555555556& AuthQuestionType=smaiden&AuthQuestionAnswer=jones&ResponseType=XML
The response confirms the successful creation of the subaccount: Successful {B301E3A9-1BFF-4600-9B2D-D214C29325A9} 661-zw-1374 CREATESUBACCOUNT 0 ResellerTest rcom true
Related commands CheckLogin CreateAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory SubAccountDomains UpdateAccountInfo UpdateCusPreferences
3/13/09
88
©2003-2009 Register.com, 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 partners have access to this 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.
•
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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition PaksRemoved
Number of POP paks removed from the domain name
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
3/13/09
89
©2003-2009 Register.com, Inc.
API commands: DeleteAllPOPPaks
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=DeleteAllPOPPaks& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&ResponseType=XML
In the response, the error count 0 confirms that the command executed successfully: E False DELETEALLPOPPAKS 0 RESELLERTEST rcom True True true
Related commands DeletePOP3 DeletePOPPak Forwarding GetForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetUpPOP3User
3/13/09
90
©2003-2009 Register.com, 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 account’s address book.
Availability All partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
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.
ResponseType
Format of response. Options are Text (default), HTML, 4 or XML.
Optional
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
91
©2003-2009 Register.com, Inc.
API commands: DeleteContact
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 account’s address book, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=DELETECONTACT& uid=rcompartnerid&pw=rcompartnerpw& registrantpartyid={4545A013-B40A-4D50-A15A-5D4356723794}&responsetype=xml
In the response, the ErrCount value 0 confirms that the query was successful: DELETECONTACT en 0 0 10 RESELLERTEST rcom +0.00 1.082 true
Related commands AddContact GetAddressBook GetContacts GetSubAccounts
3/13/09
92
©2003-2009 Register.com, Inc.
API commands: DeleteCustomerDefinedData
DeleteCustomerDefinedData Description Definition Delete customer-defined data records.
Usage Use this command to delete customer-defined data.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ObjectID
Required
Object ID number, an integer assigned when this customer-defined field was first established.
2
Type
Required
Object type. Permitted values are: 1 Data pertaining to an account 2 Data pertaining to a domain 3 Data pertaining to an order
1
SLD
Required if Type=2
Second-level domain name (for example, register in register.com)
63
TLD
Required if Type=2
Top-level domain name (extension)
15
OrderID
Required if Type=3
Order ID, which you can retrieve using the GetDomainStatus comand.
11
Key
Required
Title of this entry, or label describing this data field
50
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
93
©2003-2009 Register.com, Inc.
API commands: DeleteCustomerDefinedData
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=deletecustomerdefineddata& uid=rcompartnerid&pw=rcompartnerpw&ObjectID=1&Type=1&Key=FavoriteCuisine& responsetype=xml
In the response, the ErrCount value 0 confirms that the query was successful: DELETECUSTOMERDEFINEDDATA 0 RESELLERTEST rcom True True true
Related commands GetCustomerDefinedData SetCustomerDefinedData
3/13/09
94
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ItemNumber
Either ItemNumber or EmptyCart is Required
Item ID number of the item to be deleted from the shopping cart. Use the GetCartContent command to retrieve the item ID numbers.
10
EmptyCart
Either ItemNumber or EmptyCart is Required
Use EmptyCart=On to completely empty the shopping cart.
2
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition ItemDeleted
True if deleted.
Command
Name of command executed
3/13/09
95
©2003-2009 Register.com, Inc.
API commands: DeleteFromCart
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=DeleteFromCart& uid=rcompartnerid&pw=rcompartnerpw&ItemNumber=365485&ResponseType=XML
The response confirms the successful deletion from the shopping cart: True DELETEFROMCART 0 ResellerTest rcom true
Related commands AddBulkDomains AddToCart GetCartContent InsertNewOrder PurchasePreview UpdateCart
3/13/09
96
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
OldRegistrationStatus
Registration status before running this query
Status
Success status for canceling DNS hosting on this domain
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
97
©2003-2009 Register.com, Inc.
API commands: DeleteHostedDomain
Param name
Definition
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=DeleteHostedDomain& uid=rcompartnerid&pw=rcompartnerpw&sld=ExternalHostedDomain&tld=com&responsetype=xml
In the response, the OldRegistrationStatus value Hosted and the ErrCount value 0 indicate that the query was successful: E False Hosted Success DELETEHOSTEDDOMAIN en 0 0 1 10 Reseller3 rcom True True +03.00 0.15625 true
Related commands ExtendDomainDNS PurchaseHosting
3/13/09
98
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
NS
Required
Use name of name server, in format dns1.ServerName.com
60
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarLock
Registrar lock status
NsSuccess
Success of the name server reset process
RegistrarLock
Registrar lock setting
RRPCode
Registry code
3/13/09
99
©2003-2009 Register.com, Inc.
API commands: DeleteNameServer
Param name Definition RRPText
Description of Registry code
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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.partnerdomain.com at the Registry, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=deletenameserver& uid=rcompartnerid&pw=rcompartnerpw&ns=dns3.partnerdomain.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: ACTIVE 1 REGISTRAR-LOCK 200 Command completed successfully DELETENAMESERVER 0 RESELLERTEST rcom True True true
3/13/09
100
©2003-2009 Register.com, Inc.
API commands: DeleteNameServer
Related commands CheckNSStatus GetDNS GetDNSStatus ModifyNS ModifyNSHosting RegisterNameServer UpdateNameServer
3/13/09
101
©2003-2009 Register.com, 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 partners have access to this 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 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
PopUser
Required
POP mailbox user name to delete
16
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
3/13/09
102
©2003-2009 Register.com, Inc.
API commands: DeletePOP3
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=DeletePOP3& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&POPUser=james& responsetype=xml
In the response, the error count of 0 confirms that the POP user was deleted successfully: E False DELETEPOP3 0 ResellerTest rcom True True true
Related commands DeleteAllPOPPaks DeletePOPPak Forwarding GetCatchAll GetForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetCatchAll SetUpPOP3User
3/13/09
103
©2003-2009 Register.com, 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 partners have access to this 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 pak must have no user email accounts currently configured.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
BundleID
Required
ID number of the POP pak to delete. Use GetPOP3 to get POP 6 pak IDs.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
3/13/09
104
©2003-2009 Register.com, Inc.
API commands: DeletePOPPak
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=DeletePOPPak& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&BundleID=5733& ResponseType=XML
The ErrCount value 0 confirms that the command was successful: E False DELETEPOPPAK 0 rcom True True true
Related commands DeleteAllPOPPaks DeletePOP3 Forwarding GetForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetUpPOP3User
3/13/09
105
©2003-2009 Register.com, 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 partners have access to this 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 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
EndUserIP
Required
End user’s IP address. Permitted format is NNN.NNN.NNN.NNN
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
106
©2003-2009 Register.com, Inc.
API commands: DeleteRegistration
Returned parameters and values Param name Definition DomainDeleted If domain deleted successfully, response is True ErrString
Error string
ErrSource
Error source
ErrSection
Error section
RRPCode
Registry success code
RRPText
Text that corresponds to and explains the RRPCode value
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=deleteregistration& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain3&tld=info& responsetype=xml
In the response, an RRPCode value 200 confirms that the query was successful: True DELETEREGISTRATION 200 Command completed successfully DELETEREGISTRATION eng 0 0 1 10 RESELLERTEST rcom True True +03.00 2.75 true
3/13/09
107
©2003-2009 Register.com, Inc.
API commands: DeleteRegistration
[CDATA ]
Related commands AddToCart Purchase
3/13/09
108
©2003-2009 Register.com, Inc.
API commands: DeleteSubaccount
DeleteSubaccount Description Definition Delete a subaccount.
Usage Use this command to delete a retail or reseller subaccount.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Account
Required
Subaccount ID number, in NNN-aa-NNNN format. You can retrieve the subaccount ID number using the GetSubAccounts command.
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
7
ResponseType
Optional
4
Format of response. Options are Text (default), HTML, or XML.
Returned parameters and values Param name Definition Action
Action to be taken with regard to deleting this subaccount
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
109
©2003-2009 Register.com, Inc.
API commands: DeleteSubaccount
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=deletesubaccount& uid=rcompartnerid&pw=rcompartnerpw&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: DELETE DELETESUBACCOUNT en 0 0 10 RESELLERTEST e +0.00 0.1523438 true
Related commands CreateAccount GetSubAccountDetails GetSubAccounts
3/13/09
110
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
Service
Required
Name of the service to be disabled. Permitted values are: WPPS (Whois Privacy Protection) EmailForwarding URLForwarding
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
111
©2003-2009 Register.com, Inc.
API commands: DisableServices
Returned parameters and values Param name Definition Service
Name of the service being disabled
ServiceStatus
New status of this service
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query disables the RCOM Shield Whois privacy protection service on partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=DISABLESERVICES& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&service=wpps& responsetype=xml
In the response, the ServiceStatus value confirms the new status of the service: E False WPPS Disabled DISABLESERVICES en 0 1 10 LOCALHOST rcom 1 True true
Related commands EnableServices GetWPPSInfo ServiceSelect
3/13/09
112
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
Service
Required
Name of the service to be enabled. Permitted values are: WPPS (RCOM Shield, our Whois privacy protection service) EmailForwarding URLForwarding
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
113
©2003-2009 Register.com, Inc.
API commands: EnableServices
Returned parameters and values Param name Definition Service
Name of the service being enabled
ServiceStatus
New status of this service
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query enables the RCOM Shield Whois privacy protection service on partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=ENABLESERVICES& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&service=wpps& responsetype=xml
In the response, the ServiceStatus value confirms the new status of the service: E False WPPS Enabled ENABLESERVICES en 0 1 10 LOCALHOST rcom 1 True true
3/13/09
114
©2003-2009 Register.com, Inc.
API commands: EnableServices
Related commands AddToCart DisableServices GetWPPSInfo PurchaseServices ServiceSelect SetRenew SetResellerServicesPricing UpdateAccountPricing
3/13/09
115
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
NumYears
Optional
Number of years to extend
10
OverrideOrder
Optional
1 Use OverrideOrder=1 to submit more than one renewal request for this domain name within 24 hours of the first transaction
UseCreditCard
Optional
If UseCreditCard=yes, use Register.com’s credit-card processing services
3/13/09
3
116
©2003-2009 Register.com, Inc.
API commands: Extend
Param name
Obligation
Definition
Max size
EndUserIP
Required if UseCreditCard =yes
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
ChargeAmount
Required if UseCreditCard =yes
Amount to charge per year for the renewal. Use DD.cc format.
6
CardType
Required if UseCreditCard =yes
Type of credit card
20
CCName
Required if UseCreditCard =yes
Cardholder's name
60
CreditCardNumber
Required if UseCreditCard =yes
Customer's credit card number
128
CreditCardExpMonth
Required if UseCreditCard =yes
Credit card expiration month
2
CreditCardExpYear
Required if UseCreditCard =yes
Credit card expiration year
4
CVV2
Required if UseCreditCard =yes
Credit card verification code
4
CCAddress
Required if UseCreditCard =yes
Credit card billing address
60
CCZip
Required if UseCreditCard =yes
Credit card billing postal code
15
CCCountry
Required if UseCreditCard =yes
Credit card billing country
60
RegistrantFirstName
Required if UseCreditCard =yes
Registrant first name
60
RegistrantLastName
Required if UseCreditCard =yes
Registrant last name
60
RegistrantAddress1
Required if UseCreditCard =yes
Registrant address
60
RegistrantAddress2
Optional
Registrant additional address info
60
RegistrantCity
Required if UseCreditCard =yes
Registrant city
60
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: S state P province
1
RegistrantStateProvince
Required if UseCreditCard =yes
Registrant state or province
60
3/13/09
117
©2003-2009 Register.com, Inc.
API commands: Extend
Param name
Obligation
Definition
Max size
RegistrantPostalCode
Required if UseCreditCard =yes
Registrant postal code
16
RegistrantCountry
Required if UseCreditCard =yes
Registrant country
60
RegistrantEmailAddress
Required if UseCreditCard =yes
Registrant email address
128
RegistrantOrganizationName
Optional
Registrant organization
60
RegistrantJobTitle
Optional
Registrant job title
60
RegistrantPhone
Required if UseCreditCard =yes
Registrant phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantFax
Optional
Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
OrderID
Order number if successful. We recommend that you store this value for future use.
Extension
Returns Successful, otherwise this parameter isn't returned.
RRPCode
Success code. Only a 200 indicates success.
RRPText
Text which accompanies and describes the RRPCode.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
If using our credit card option ALL credit card information is required.
•
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 value—at least the most recent one for each domain—from 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.
3/13/09
118
©2003-2009 Register.com, Inc.
API commands: Extend
Example The following query requests that the registration period for partnerdomain.com be extended for 1 year, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=Extend& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&NumYears=1&ResponseType=XML
The response confirms the successful extension of the registration period for the domain: False successful partnerdomain.com 156062933 200 Command completed successfully EXTEND 0 ResellerTest rcom true
Related commands Extend_RGP ExtendDomainDNS GetDomainExp GetExtendInfo GetPOPExpirations GetRenew InsertNewOrder RenewPOPBundle SetRenew UpdateExpiredDomains
3/13/09
119
©2003-2009 Register.com, 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 name’s 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com) of name in RGP status
63
TLD
Required
Top-level domain name (extension) of name in RGP status
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
Max size
120
©2003-2009 Register.com, Inc.
API commands: Extend_RGP
Returned parameters and values Param name Definition Extension
Success status of the query
DomainName
Name of the domain to be redeemed
OrderID
Order ID number. Store this number to simplify progress checks.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
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://partnertest.rcomexpress.com/interface.asp?command=Extend_RGP&uid=rcompartnerid&pw=rcompartnerpw& sld=VeryExpiredName&tld=com&ResponseType=xml
In the response, the Extension value Successful value confirms that the query was successful: E False successful VeryExpiredName.com 156251141 EXTEND_RGP en 0 0 1 10 RESELLERTEST rcom True True +03.00 0.2109375 true
3/13/09
121
©2003-2009 Register.com, Inc.
API commands: Extend_RGP
Related commands AddToCart Extend ExtendDomainDNS GetExpiredDomains GetOrderDetail GetRenew PE_GetResellerPrice PE_SetPricing Purchase PurchaseServices SetRenew UpdateExpiredDomains
3/13/09
122
©2003-2009 Register.com, 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 partners have access to this 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 not be registered with us, but must use our name servers.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
NumYears
Optional
Number of years to add to the DNS hosting subscription. Default value is 1. Maximum total is 10.
2
RegistrantFirstName
Required if using Registrant first name our credit card processing
60
RegistrantLastName
Required if using Registrant last name our credit card processing
60
RegistrantAddress1
Required if using Registrant address our credit card processing
60
3/13/09
123
©2003-2009 Register.com, Inc.
API commands: ExtendDomainDNS
Param name
Obligation
Definition
Max size
RegistrantAddress2
Optional
Registrant additional address info
60
RegistrantCity
Required if using Registrant city our credit card processing
60
RegistrantCountry
Optional
60
RegistrantEmailAddress
Required if using Registrant email address our credit card processing
128
RegistrantOrganizationName
Optional
Registrant organization
60
RegistrantJobTitle
Optional
Registrant job title
60
RegistrantPhone
Optional
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
20
RegistrantFax
Optional
Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantPostalCode
Required if using Registrant postal code our credit card processing
16
RegistrantStateProvince
Optional
Registrant state or province
60
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: S state P province
1
ChargeAmount
Optional
Amount to charge to the credit card
6
UseCreditCard
Optional
If UseCreditCard=yes, use our credit-card processing services
3
EndUserIP
Required if UseCreditCard =yes
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
CardType
Required if UseCreditCard =yes
Type of credit card. Permitted values are Visa, Mastercard, AmEx, and Discover
20
CCName
Required if UseCreditCard =yes
Cardholder's name
60
CreditCardNumber
Required if UseCreditCard =yes
Customer's credit card number
128
CreditCardExpMonth
Required if UseCreditCard =yes
Credit card expiration month, in MM format
2
CreditCardExpYear
Required if UseCreditCard =yes
Credit card expiration year, in YYYY format
4
CVV2
Required if UseCreditCard =yes
Credit card verification code
4
3/13/09
Registrant country
124
©2003-2009 Register.com, Inc.
API commands: ExtendDomainDNS
Param name
Obligation
Definition
Max size
CCAddress
Required if UseCreditCard =yes
Credit card billing address
60
CCZip
Required if UseCreditCard =yes
Credit card billing postal code
15
CCCountry
Required if UseCreditCard =yes
Credit card billing country
60
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
Registrar hold setting for this domain name
CCTransResult
Success status for the credit card transaction
OrderID
Order ID, assigned by us
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query renews DNS hosting for domain resellerdnshost.com, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=EXTENDDOMAINDNS& uid=rcompartnerid&pw=rcompartnerpw&sld=resellerdnshost&tld=com&numyears=1& RegistrantFirstName=John&RegistrantLastName=Doe&RegistrantAddress1=17462& RegistrantCity=Redmond&RegistrantPostalCode=98052&RegistrantCountry=USA& RegistrantPhone=+1.4255559999&RegistrantEmailAddress=john.doe@partnerdomain.com& 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: E
3/13/09
125
©2003-2009 Register.com, Inc.
API commands: ExtendDomainDNS
False APPROVED 156180311 EXTENDDOMAINDNS 0 1 10 RESELLERTEST rcom True True true
Related commands AddToCart DeleteHostedDomain Extend InsertNewOrder Purchase PurchaseHosting PurchasePOPBundle PurchaseServices
3/13/09
126
©2003-2009 Register.com, 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 partners have access to this command.
Constraints The query must meet the following requirements: •
The domain must be using Register.com’s 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
AddressX
Required
Address (mailbox user name) to be forwarded from this domain
30
ForwardToX
Required
Where this address will be forwarded to, in format
[email protected]
130
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
127
©2003-2009 Register.com, Inc.
API commands: Forwarding
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=Forwarding& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&
[email protected]&
[email protected]&ResponseType=XML
The error count 0 confirms that the email forwarding instructions are successful: False 2 FORWARDING 0 ResellerTest rcom true
3/13/09
128
©2003-2009 Register.com, Inc.
API commands: Forwarding
Related commands DeleteAllPOPPaks DeletePOP3 DeletePOPPak GetCatchAll GetDotNameForwarding GetForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetCatchAll SetDotNameForwarding SetPOPForwarding SetUpPOP3User
3/13/09
129
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
UserID
Current login ID
Password
Current account password
AuthQuestionType
Current authorization question
AuthQuestionAnswer
Current answer to the authorization question
Account
Account number
Reseller
Is this a reseller account or not
AcceptTerms
Returns True if the credit card agreement has been signed, False otherwise
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
130
©2003-2009 Register.com, Inc.
API commands: GetAccountInfo
Param name
Definition
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetAccountInfo& uid=rcompartnerid&pw=rcompartnerpw&ResponseType=XML
The response is as follows: rcompartnerid rcompartnerpw smaiden Jones 217-no-0647 True True GETACCOUNTINFO 0 ResellerTest rcom true
3/13/09
131
©2003-2009 Register.com, Inc.
API commands: GetAccountInfo
Related commands CheckLogin CreateAccount CreateSubAccount GetAccountPassword GetAllAccountInfo GetConfirmationSettings GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory UpdateAccountInfo UpdateCusPreferences
3/13/09
132
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
LoginID
Required
Login ID for the account for which you want the password.
20
AuthQuestionAnswer
Required
Answer to the authorization question
50
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
GotAccountInfo
Account information has been located in the registrar’s database.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
133
©2003-2009 Register.com, Inc.
API commands: GetAccountPassword
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 giambi, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetAccountPassword& uid=rcompartnerid&pw=rcompartnerpw&LoginID=giambi&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. true GETACCOUNTPASSWORD 0 Dev Workstation rcom true
Related commands CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountValidation GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory SendAccountEmail UpdateAccountInfo UpdateCusPreferences
3/13/09
134
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size 20
UID
Required
Login ID of the parent account
PW
Required
Password of the parent account
20
LoginID
Required
Login ID of the subaccount
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
AuthQuestionType
The authorization question for the subaccount
AuthQuestionAnswer The answer to the authorization question for the subaccount LoginID
The login ID of the subaccount
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
135
©2003-2009 Register.com, Inc.
API commands: GetAccountValidation
Param name
Definition
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 giambi and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getaccountvalidation& uid=rcompartnerid&pw=rcompartnerpw&loginid=giambi&responsetype=xml
In the response, values for AuthQuestionType and AuthQuestionAnswer indicate that the query was successful: Mother's Maiden Name Smith giambi GETACCOUNTVALIDATION en 0 0 10 RESELLERTEST rcom +0.00 0.0390625 true
Related commands GetAccountPassword GetSubAccounts GetSubaccountsDetailList SendAccountEmail
3/13/09
136
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
PageSize
Optional; default is 100
Number of contacts to return in this response
4
Page
Optional; default is 1
Which page of responses to return. For example, if PageSize=100&Page=2 generates the second “page” of 100 contacts: contacts 101 through 200.
3
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
Address Rec
Record number for this contact, assigned dynamically when this query runs
PartyID
Party ID for this contact, a permanent value
3/13/09
137
©2003-2009 Register.com, Inc.
Param name
Definition
API commands: GetAddressBook
OrganizationName
Organization name
JobTitle
Job title
FirstName
First name
LastName
Last name
Address1
Street address, first line
Address2
Street address, second line
City
City
StateProvince
State or province
StateProvinceChoice
S indicates the StateProvince value is a state; P indicates province
PostalCode
Postal code
Country
Country
Phone
Phone number
PhoneExt
Phone extension
Fax
Fax number
Email
Email address
Count
Number of contacts returned in this response (may be fewer than the PageSize value)
TotalPages
Total number of “pages” of contacts that exist for this account, given the PageSize value submitted in this query.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The 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 rcompartnerid and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GETADDRESSBOOK& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
In the response, address records, a Count value, and a TotalPages value confirm that the query was successful:
3/13/09
138
©2003-2009 Register.com, Inc.
API commands: GetAddressBook
{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629} Partner Domains Inc. President John Doe 111 Main St. Hometown NY S 99999 US +1.5555555555 +1.5555555556
[email protected] {AD45BE6C-B3FA-4F7D-ADC1-A1D5B97EAB4B} eMachines, Inc. Administration, Domains 14350 Myford Rd. Bldg. #100 Irvine CA S 92606 US (714) 481-2828
[email protected] . . . 100 3 GETADDRESSBOOK en 0 0 1 10 RESELLERTEST rcom True True +03.00 6.515625 true
3/13/09
139
©2003-2009 Register.com, Inc.
API commands: GetAddressBook
Related commands AddContact Contacts DeleteContact GetContacts GetExtAttributes GetResellerInfo GetServiceContact GetWhoisContact Preconfigure
3/13/09
140
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
OrganizationName
Name of organization
JobTitle
Job title
FName
First Name
LName
Last Name
Address1
Address line 1
Address2
Address line 2
City
City
StateProvince
State or province
StateProvinceChoice
State or province choice
PostalCode
Postal code
3/13/09
141
©2003-2009 Register.com, Inc.
API commands: GetAllAccountInfo
Param name
Definition
Country
Country
Phone
Telephone number
Fax
Fax number
EmailAddress
Email address for Whois
EmailAddress_Contact Email address for us to contact you about your domain name account UserID
Current account ID
Password
Current account password
AuthQuestionType
Current type of question setting
AuthQuestionAnswer
Current question answer
Account
Account number
Reseller
Is this a reseller account or not
CardType
Type of credit card
CCName
Cardholder's name
CreditCardNumber
Customer's credit card number
CreditCardExpMonth
Credit card expiration month
CreditCardExpYear
Credit card expiration year
CCAddress
Credit card billing address
CCZip
Credit card billing postal code
CCCountry
Credit card billing country
DefPeriod
Default number of years to register a name
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetAllAccountInfo& uid=rcompartnerid&pw=rcompartnerpw&ResponseType=XML
The response is as follows: Partner Domains Inc. President John Doe 111 Main St.
3/13/09
142
©2003-2009 Register.com, Inc.
API commands: GetAllAccountInfo
Hometown NY S 99999 US 5555555555 5555555556
[email protected] rcompartnerid rcompartnerpw smaiden Jones 217-no-0647 True True GETALLACCOUNTINFO 0 Dev Workstation rcom true
Related commands CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetResellerInfo GetSubAccountDetails GetSubAccounts GetTransHistory RPT_GetReport UpdateAccountInfo UpdateCusPreferences
3/13/09
143
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
UseDNS
Optional
Returns a list of domains that use custom (user-specified) name servers. Permitted value is custom.
10
GetDefaultOnly Optional
Returns default name servers. Value is 1.
1
Letter
Optional
Returns domains with the specified first character. Permitted values are 0 through 9 and A through Z.
1
RegistrarLock
Optional
Returns domains with the specified Registrar Lock status. Permitted values are Locked and Not Locked.
10
AutoRenew
Optional
Returns domains with the specified Auto Renew status. Permitted values are Yes and No.
3
Name
Optional
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.
3/13/09
144
©2003-2009 Register.com, Inc.
API commands: GetAllDomains
Param name Obligation
Definition
Max size
ContactType
Optional
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.
NameServer
Optional
Returns domains that use the specified name server. Use format dns1.nameserver.com.
135
ResponseType
Optional
Format of response. Options are XML (recommended), HTML, or Text (default).
4
Returned parameters and values Param name
Definition
DomainName
Name of the domain described in this node
DomainNameID
Database ID of this domain
Expiration-Date
Expiration date of this domain
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetAllDomains &uid=rcompartnerid&pw=rcompartnerpw&ResponseType=XML
The response lists all domain names in the account, with the ID number and expiration date for each domain: partnerdomain.com 317534985 6/23/2005 6:44:19 PM partnerdomain2.net 317564218 6/23/2005 6:53:23 PM
3/13/09
145
©2003-2009 Register.com, Inc.
API commands: GetAllDomains
partnerdomain3.info 152533676 6/23/2005 7:15:50 PM . . . DomainBox GETALLDOMAINS 0 Dev Workstation rcom true
Related commands GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetHomeDomainList GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
146
©2003-2009 Register.com, Inc.
API commands: GetBalance
GetBalance Description Definition Get account balances.
Usage Use this command to return the current balance on an account.
Availability All partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
Reseller
Returns 1 if this is a reseller account, 0 otherwise
Balance
Current account balance
AvailableBalance
Current available balance
Price
Default price for names
COMPrice
Price for .com
NETPrice
Price for .net
ORGPrice
Price for .org
CCPrice
Price for .cc
TVPrice
Price for .tv
3/13/09
147
©2003-2009 Register.com, Inc.
API commands: GetBalance
Param name
Definition
DomainCount
Current count of domains in the account
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetBalance& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response lists the balance and the available balance: 1 3,709.20 3,669.40 74 GETBALANCE 0 ResellerTest rcom true
Related commands CommissionAccount UpdateNotificationAmount
3/13/09
148
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
ItemID
Item number
Description
Nature of the transaction. Options are Register, Renew
Years
Number of years to register
NameID
Name ID
Name
Domain name
StatusID
Current status of the name. Value A indicates item is active and will be affected by future transactions, or I for inactive
ItemPrice
Item price
Renew
Auto-renew setting. Value 1 indicates this item is set to auto-renew, 0 indicates this item is not set to auto-renew
3/13/09
149
©2003-2009 Register.com, Inc.
API commands: GetCartContent
Param name
Definition
NeedsConfig
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.
IsMailPak
An IsMailPak value of 1 indicates that the POP Email 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 Email to the shopping cart.
ShowWPPSLink
A ShowWPPSLink value of 1 indicates that the Whois Privacy Protection Service (WPPS, RCOM Shield) 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.
QtyDesc
Unit by which this item is sold
SubItem
A SubItem value of 0 indicates that this item is a single line item in the shopping cart
FreeTrial
A FreeTrial value of 0 indicates that the user begins paying for this item as soon as it is purchased
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetCartContent& uid=rcompartnerid&pw=rcompartnerpw&ResponseType=XML
The response indicates that the shopping cart currently contains a domain to register (partnerdomain.us): 393955 Register 10 1 152556457 partnerdomain.us I 10.00 0
3/13/09
150
©2003-2009 Register.com, Inc.
API commands: GetCartContent
1 0 1 Year(s) 0 0 GETCARTCONTENT 0 RESELLERTEST rcom True True true
Related commands AddBulkDomains AddToCart DeleteFromCart InsertNewOrder PurchasePreview UpdateCart
3/13/09
151
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition CatchAll
Email address that mail will be sent to if the addressee mailbox does not exist
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
152
©2003-2009 Register.com, Inc.
API commands: GetCatchAll
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GetCatchAll& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com& responsetype=xml
In the response, the presence of the Catch-All email address confirms that the query was successful:
[email protected] GETCATCHALL eng 0 0 1 10 RESELLERTEST rcom True True +03.00 0.125 true
Related commands DeletePOP3 Forwarding GetDotNameForwarding GetForwarding GetPOP3 GetPOPForwarding SetCatchAll SetDotNameForwarding SetPOPForwarding SetUpPOP3User
3/13/09
153
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Reseller
Is this a reseller account?
ProdCode
Product text ID
ProdType
Product number ID
ProdDesc
Product description
QtyDesc
Units in which this product is sold
RetailPrice
Retail selling price charged to customers
ResellerPrice
Wholesale price this account pays
Enabled
Is this product enabled for selling?
Years
Quantities available. For example, Years=3 indicates that a customer can buy a 3year registration of this product.
3/13/09
154
©2003-2009 Register.com, Inc.
API commands: GetCerts
Param name Definition CertCount
Number of SSL certificate products listed in this return
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GetCerts& UID=rcompartnerid&PW=rcompartnerpw&ResponseType=XML
In the response, a list of certificates and an ErrCount value 0 confirm that the query was successful: True certificate-rapidssl-rapidssl 23 SSL Certificate - RapidSSL Year(s) $78.00 $9.95 True 1 2 3 4 5 certificate-geotrust-quickssl 26 SSL Certificate - GeoTrust QuickSSL Year(s) $500.00 $69.00 True 1 2 3 4
3/13/09
155
©2003-2009 Register.com, Inc.
API commands: GetCerts
5 . . . 10 GETCERTS en 0 0 10 RESELLERTEST rcom +0.00 0.1992188 true
Related commands CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert
3/13/09
156
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
OrderConfirmation
The setting for sending copies of order confirmation emails to you, when orders are placed on this account
TransferOrderConfirmation
The setting for sending copies of transfer request emails to you, when orders are placed on this account
OrderConfirmationBCC
The setting for sending copies of order confirmation emails to you, when orders are placed on a subaccount of this account
TransferOrderConfirmationBCC
The setting for sending copies of transfer request emails to you, when orders are placed on a subaccount of this account
EmailHead
If set for custom email text, the header string that will be used
EmailTail
If set for custom email text, the tail string that will be used
3/13/09
157
©2003-2009 Register.com, Inc.
API commands: GetConfirmationSettings
Param name
Definition
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GetConfirmationSettings& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
In the response, return values in the ConfirmationSettings node confirms that the query was successful: True True True True Thank you for your recent order. Thanks again for using our online services. GETCONFIRMATIONSETTINGS en 0 0 10 RESELLERTEST rcom +0.00 8.203125E-02 true
3/13/09
158
©2003-2009 Register.com, Inc.
API commands: GetConfirmationSettings
Related commands GetAccountInfo GetCusPreferences GetSubAccountDetails GetTLDList PE_GetRetailPricing PE_SetPricing UpdateCusPreferences
3/13/09
159
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DomainName
Domain name
SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain name (extension)
DomainNameID
Identification number for this domain name, in our system
3/13/09
160
©2003-2009 Register.com, Inc.
API commands: GetContacts
Param name
Definition
Registrant
None indicates no separate Registrant information has been entered for this domain name. Otherwise, Registrant information is returned
AuxBilling
None indicates no separate Auxiliary Billing information has been entered for this domain name. Otherwise, Auxiliary Billing contact information is returned
Tech
None indicates no separate Technical contact information has been entered for this domain name. Otherwise, Technical contact information is returned
Admin
None indicates no separate Admin contact information has been entered for this domain name. Otherwise, Admin contact information is returned
Billing
Billing information is returned for most TLDs, with some exceptions like .eu
ContactTypePartyID
Party ID
ContactTypeAddress1
Address 1
ContactTypeAddress2
Address 2
ContactTypeCity
City
ContactTypeCountry
Country
ContactTypeEmailAddress
Email Address
ContactTypeFax
Fax
ContactTypeFirstName
First Name
ContactTypeLastName
Last Name
ContactTypeJobTitle
Job Title
ContactTypeOrganizationName
Organization Name
ContactTypePhone
Phone number
ContactTypePhoneExt
Phone extension
ContactTypePostalCode
Postal Code
ContactTypeStateProvince
State or Province
ContactTypeStateProvinceChoice State or Province? S indicates State; P indicates Province UseBelowAuxInfo
True indicates that AuxBilling appears on the Contacts page as an optional alternative for this ContactType
AuxID
PartyID for Auxiliary Billing contact
RegID
PartyID for Registrant contact
ExtendedAttributes
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.
WPPSAllowed
Is RCOM Shield permitted for this TLD?
WPPSExists
Is there a current RCOM Shield subscription for this domain name?
WPPSEnabled
Is the RCOM Shield subscription currently being used to protect this domain name?
WPPSExpDate
Expiration date for RCOM Shield subscription
WPPSAutoRenew
Auto renew setting for RCOM Shield subscription
EscrowLiftDate
If this domain name is currently in escrow, the lift date
EscrowHold
Is this domain name currently in escrow?
ContactRestrictedTLD
Does this TLD have restrictions on the freedom to update contact information without a trade (transfer)?
Command
Name of command executed
3/13/09
161
©2003-2009 Register.com, Inc.
API commands: GetContacts
Param name
Definition
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getcontacts& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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: False partnerdomain.com {F6A676E4-5BB7-453C-87A6-9BBB164318F5} 100 Main St. Townsville US
[email protected] John Smith 5555555555 None None None
3/13/09
162
©2003-2009 Register.com, Inc.
API commands: GetContacts
{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629} 111 Main Street Hometown US
[email protected] 555-555-5556 John President Doe Partner Domains Inc. 555-555-5555 99999 NY S United States True {F6A676E4-5BB7-453C-87A6-9BBB164318F5} GETCONTACTS 0 ResellerTest rcom true
Related commands AddContact Contacts DeleteContact GetAddressBook GetExtAttributes GetResellerInfo GetServiceContact GetWhoisContact Preconfigure
3/13/09
163
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResellerKey
Optional
Reseller EC key for this site, if different from this UID
40
ResellerStatus
Optional
ResellerStatus=1 retrieves information about reseller balances
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DefPeriod
Default period for registrations, renewals, and transfers, in years
AllowDNS
True allows name servers other than Register.com’s
ShowPopUps
True shows pop-up menus
AutoRenew
True automatically renews the domain 30 days before it expires
RegLock
True requires the account holder’s permission to transfer the domain to another registrar
AutoPakRenew
True automatically renews POP paks 30 days before they expire.
3/13/09
164
©2003-2009 Register.com, Inc.
API commands: GetCusPreferences
Param name
Definition
UseDNS
True uses Register.com’s name servers
ResellerStatus
Is this a reseller account?
RenewalSetting
0 indicates no email; 1 indicates send notice; 2 indicates contact and charge customer
RenewalBCC
1 indicates send copy of email to reseller; 0 indicates no copy to reseller
RenewalURLForward
True automatically renews URL forwarding 30 days before the URL forwarding subscription expires.
RenewalEMailForward
True automatically renews email forwarding 30 days before the email forwarding subscription expires.
HostName
Name of this default host record
Address
Address of this default host record
RecordType
Record type of this default host record
DefaultHostRecordOwn
Is this account using its own set of default host records?
UseOurDNS
Does this account use Register.com’s DNS servers by default?
DNSX
Default DNS server X for this domain name account
AcceptTerms
True indicates this account has signed a credit-card processing agreement with us
URL
URL for reseller site listed in email notices
ParentAccount
This account’s parent
NoService
Service status
BulkRegLimit
Maximum number of names this account can register in a single query
Balance
Current balance for this reseller account
BalanceThreshold
Balance threshold for this reseller account
Price
Wholesale price this account pays for .com
CCPrice
Wholesale price this account pays for .cc
AvailableBalance
Avaliable balance for this account
ResCustomerPrice CommissionBalance
Current commission balance for this account
NotifyAmount
Send a notification email to the Billing contact for this account when available balance drops below this amount
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
3/13/09
165
©2003-2009 Register.com, Inc.
API commands: GetCusPreferences
Example The following query retrieves the account settings for rcompartnerid and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetCusPreferences& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response is as follows: 4 False False False False False True 0 0 False False True GETCUSPREFERENCES 0 RESELLERTEST rcom 0 0 true
Related commands GetConfirmationSettings UpdateCusPreferences UpdateRenewalSettings
3/13/09
166
©2003-2009 Register.com, Inc.
API commands: GetCustomerDefinedData
GetCustomerDefinedData Description Definition Retrieve customer-defined data.
Usage Use this command to retrieve custom data.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ObjectID
Required
Object ID number, an integer assigned when this customer-defined field was first established.
2
Type
Required
Object type. Options are: 1 Data pertaining to an account 2 Data pertaining to a domain 3 Data pertaining to an order
1
SLD
Required if Type=2
Second-level domain name (for example, register in register.com)
63
TLD
Required if Type=2
Top-level domain name (extension)
15
OrderID
Required if Type=3
Order ID, which you can retrieve using GetDomainStatus
11
Key
Required
Title of this entry, or label describing this data field
50
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
167
©2003-2009 Register.com, Inc.
API commands: GetCustomerDefinedData
Returned parameters and values Param name
Definition
Value
Content of this entry
DisplayFlag
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
EnteredBy
Name of the person adding this entry
LastUpdatedDate
Last date on which this entry was changed
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getcustomerdefineddata& uid=rcompartnerid&pw=rcompartnerpw&ObjectID=1&Type=1&Key=FavoriteCuisine& responsetype=xml
The response is as follows: Italian True John 7/7/2003 5:46:10 PM GETCUSTOMERDEFINEDDATA 0 RESELLERTEST rcom True True true
3/13/09
168
©2003-2009 Register.com, Inc.
API commands: GetCustomerDefinedData
Related commands DeleteCustomerDefinedData SetCustomerDefinedData
3/13/09
169
©2003-2009 Register.com, Inc.
API commands: GetCustomerPaymentInfo
GetCustomerPaymentInfo Description Definition Retrieve customer payment information.
Usage Use this command to retrieve customer payment information.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
CCName
Credit card holder’s name
CCNumber
Credit card number
CCType
Credit card type
CCMonth
Credit card expiration month
CCYear
Credit card expiration year
CCAddress
Credit card billing address street address
CCZip
Credit card billing address postal code
CCCity
Credit card billing address city
CCStateProvince
Credit card billing address province
CCCountry
Credit card billing address country
3/13/09
170
©2003-2009 Register.com, Inc.
API commands: GetCustomerPaymentInfo
Param name
Definition
CCPhoneDial
Telephone country code
CCPhone
Telephone number with area code
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GetCustomerPaymentInfo& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response is as follows: John Doe ************5215 MASTERCARD 11 2005 17462 98052 Hometown NY US 1 5555559999 GETCUSTOMERPAYMENTINFO en 0 0 10 RESELLERTEST rcom +0.00 8.203125E-02 true
3/13/09
171
©2003-2009 Register.com, Inc.
API commands: GetCustomerPaymentInfo
Related commands CreateAccount CreateSubAccount GetAccountInfo GetAllAccountInfo GetSubAccountDetails GetSubAccounts UpdateAccountInfo UpdateCusPreferences
3/13/09
172
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
NSCount
Number of DNS entries
DNSX
Name server X. Indexed X when ResponseType=Text or HTML.
UseDNS
Which name servers a domain is using. Default indicates our name servers
NSStatus
Returns yes if using registrar's name servers.
Command
Name of command executed
3/13/09
173
©2003-2009 Register.com, Inc.
API commands: GetDNS
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetDNS& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&ResponseType=XML
The response is as follows: False dns01.gpn.register.com dns02.gpn.register.com dns03.gpn.register.com dns04.gpn.register.com dns05.gpn.register.com ours Yes GETDNS 0 Dev Workstation rcom true
Related commands CheckNSStatus DeleteNameServer GetDNSStatus ModifyNS ModifyNSHosting RegisterNameServer UpdateNameServer
3/13/09
174
©2003-2009 Register.com, 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 Register.com servers.
Availability All partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
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 Command
3/13/09
Name of command executed
175
©2003-2009 Register.com, Inc.
API commands: GetDNSStatus
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com -- that is, whether the domain uses its registrar’s servers. The query also requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetDNSStatus& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&ResponseType=XML
The NS status Yes indicates that the domain uses the registrar’s name servers: ours 15 GETDNSSTATUS 0 Dev Workstation rcom true
Related commands CheckNSStatus DeleteNameServer GetDNS ModifyNS ModifyNSHosting RegisterNameServer UpdateNameServer
3/13/09
176
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
RegisteredCount
Number of registered domain names.
HostCount
Number of hosted domain names.
ExpiredDomainsCount
Number of expired domain names.
ProcessCount
Number of domain names that are still processing.
KeywordCount
Number of keywords (obsolete feature).
WatchlistCount
Number of domain names in the watchlist.
CartItemCount
Number of items in the shopping cart.
ExpiringCount
Number of expiring domain names.
Command
Name of command executed
3/13/09
177
©2003-2009 Register.com, Inc.
API commands: GetDomainCount
Param name
Definition
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetDomainCount& uid=rcompartnerid&pw=rcompartnerpw&ResponseType=XML
The response indicates that the account has 72 registered and 2 hosted domains: 72 2 0 0 0 0 2 0 GETDOMAINCOUNT 0 Dev Workstation rcom true
3/13/09
178
©2003-2009 Register.com, Inc.
API commands: GetDomainCount
Related commands GetAllDomains GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
179
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
ExpirationDate Expiration date for the domain registration. Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
180
©2003-2009 Register.com, Inc.
API commands: GetDomainExp
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetDomainExp& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&ResponseType=XML
The response indicates that the expiration date for the domain is 6/25/2012: False 6/25/2012 4:20:24 PM GETDOMAINEXP 0 Dev Workstation rcom true
Related commands Extend Extend_RGP GetAllDomains GetDomainCount GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword InsertNewOrder SetPassword SetRegLock SetRenew StatusDomain UpdateExpiredDomains ValidatePassword
3/13/09
181
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain name (extension)
DomainNameID
ID number of this individual domain
3/13/09
182
©2003-2009 Register.com, Inc.
API commands: GetDomainInfo
Param name
Definition
Multy-LangSLD
Is this a multi-language SLD?
Expiration
Expiration date of this domain registration
Registrar
Registrar of this domain
RegistrationStatus
Registration status of this domain
Purchase-Status
Purchase status of this domain
Party-ID
Party ID of the account in which this domain is registered
Belongs-To
Login ID of the account in which this domain is registered
Entry Name
Name of the product or service described in this node
Changable
Can this service be changed?
Service
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 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 server’s IP address required) 1114 POP3/WebMail plus email forwarding WPPS (RCOM Shield Whois Privacy Protection): 1120 WhoIs information is masked 1123 WhoIs information is viewable
Service Changable
Can this service be toggled on or off, or switched?
ConfigurationChangable Is this a configurable product or service? Name
Name of this host record
Type
Type of product, service, or host record
Address
Host record address
MXPref
Priority value of this host record
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query requests domain information—status and services— for partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetDomainInfo& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&ResponseType=XML
3/13/09
183
©2003-2009 Register.com, Inc.
API commands: GetDomainInfo
The response is as follows: E False partnerdomain.com 6/10/2013 3:56:56 PM Register.com, Inc. Registered Paid rcompartnerid 1006 dns01.gpn.register.com dns02.gpn.register.com dns03.gpn.register.com dns04.gpn.register.com dns05.gpn.register.com 1021 ' A 10 ' CNAME 10 '
3/13/09
184
©2003-2009 Register.com, Inc.
API commands: GetDomainInfo
FRAME 10 1066 rcomwebid 1114 1120
[email protected] [email protected] Nov 26, 2006 No 1087 GETDOMAININFO en 0 0 1 10 RESELLERTEST rcom True True +03.00 0.390625 true
3/13/09
185
©2003-2009 Register.com, Inc.
API commands: GetDomainInfo
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomains GetExpiredDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
186
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DomainRRP
Processor identifier of the registrar which manages the domain
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain name (extension)
3/13/09
187
©2003-2009 Register.com, Inc.
Param name
Definition
DomainNameID
Identification number of this domain name
API commands: GetDomainNameID
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getdomainnameid& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The successful response returns the domain name ID: E False partnerdomain com 152533676 GETDOMAINNAMEID 0 RESELLERTEST rcom True True true
Related commands GetDomainSLDTLD
3/13/09
188
©2003-2009 Register.com, 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 our older 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. AdvancedDomainSearch is the most up-to-date command for accounts of all sizes.
Availability All partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Tab
Optional; default is IOwn
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 account’s 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
10
DaysToExpired
Optional with Tab=ExpiringNames
Return names that expire within this number of 4 days, whether they are set to auto-renew or not
RegStatus
Optional with Tab=Sub_IOwn; default is Registered
The type of domains to return for a subaccount. Permitted values are Registered and Expired.
3/13/09
10
189
©2003-2009 Register.com, Inc.
API commands: GetDomains
Param name
Obligation
Definition
Max size
Display
Optional; default is 25
Number of domains to return in one response. Permitted values are 0 to 100.
4
Start
Optional; default is 1
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.
4
OrderBy
Optional
The order to return the results. Permitted values are SLD, TLD, DNS, and ExpirationDate.
15
StartLetter
Optional
Return names that start with this letter
1
MultiLang
Optional
If MultiLang=On, display SLD in native character set in UI.
1
Domain
Optional
Return names that match this name. Use format SLD.TLD
60
ExtFormat
Optional
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.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DomainNameIDX
Domain name ID. Indexed X when ResponseType=Text or HTML.
SLDX
Second-level domain name (for example, register in register.com). Indexed X when ResponseType=Text or HTML.
TLDX
Top-level domain name (extension). Indexed X when ResponseType=Text or HTML.
NS-StatusX
Name server status. YES indicates this domain uses our name servers. Indexed X when ResponseType=Text or HTML.
Expiration-DateX
Expiration date of the domain registration. Indexed X when ResponseType=Text or HTML.
Auto-RenewX
Auto-renew setting. Return values are Yes or No. Indexed X when ResponseType=Text or HTML.
WPPSStatusX
WhoIs privacy protection setting. Return values are Enabled or Disabled. Indexed X when ResponseType=Text or HTML.
RRProcessor
RR processor. Indexed X when ResponseType=Text or HTML.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
190
©2003-2009 Register.com, Inc.
API commands: GetDomains
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 rcompartnerid, 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://partnertest.rcomexpress.com/interface.asp?command=GetDomains& uid=rcompartnerid&pw=rcompartnerpw&ResponseType=XML
The response lists the first 25 domains in account rcompartnerid, starting with partnerdomain.com and partnerdomain3.info. It also provides some summary information about the total contents of the account: iown 152533676 partnerdomain com Yes 6/25/2012 152533677 partnerdomain3 info Yes 6/25/2004 . . . 25 0 26 True 1 72 72 GETDOMAINS 0 Dev Workstation rcom true
3/13/09
191
©2003-2009 Register.com, Inc.
API commands: GetDomains
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetExpiredDomains GetExtendInfo GetHomeDomainList GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
192
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
WebSite
Web site setting
IPResolver
Setting for resolving dynamic IP addresses
DomainNameID
ID number for this domain, from our internal records
EMailForwarding
Email forwarding setting for this domain
EmailForwardExpDate
Expiration date for email forwarding
3/13/09
193
©2003-2009 Register.com, Inc.
API commands: GetDomainServices
Param name
Definition
EMailAutoRenew
Auto-renew setting for email forwarding
URLForwarding
URL forwarding setting for this domain
URLForwardExpDate
Expiration date for URL forwarding
URLAutoRenew
Auto-renew setting for URL forwarding
EMailForwardingPrice
Price for email forwarding
URLForwardingPrice
Price for URL forwarding
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetDomainServices& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml&sld=partnerdomain&tld=com
The response is as follows: 0 False 0 False 152551776 0 0 0.00 0.00 GETDOMAINSERVICES 0 1 10 RESELLERTEST rcom
3/13/09
194
©2003-2009 Register.com, Inc.
API commands: GetDomainServices
0 0 true
Related commands DisableServices EnableServices ServiceSelect SetDomainSubServices
3/13/09
195
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
DomainNameID
Required
Domain name ID
11
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DomainRRP
Registrar identifier
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain name (extension)
DomainNameID
Domain name ID
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
196
©2003-2009 Register.com, Inc.
API commands: GetDomainSLDTLD
Param name
Definition
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=getdomainsldtld& uid=rcompartnerid&pw=rcompartnerpw&domainnameid=152533676&responsetype=xml
The response is as follows: E False partnerdomain com 152533676 GETDOMAINSLDTLD 0 RESELLERTEST rcom True True true
Related commands GetDomainInfo GetDomainNameID
3/13/09
197
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition HostID
Identification number for this SRV record, assigned by us
HostName
Use name you have assigned to this SRV record
Protocol
Internet protocol you have assigned for this SRV record
Address
Fully qualified domain name you have assigned for this SRV record
RecordType
Host record type for this record—should always be SRV
3/13/09
198
©2003-2009 Register.com, Inc.
API commands: GetDomainSRVHosts
Param name Definition MXPref
MXPref value. Not used for SRV records
Weight
Weight you have assigned to this SRV record (for load balancing)
Priority
Priority you have assigned to this SRV record (for backup servers)
Port
Port you have assigned to this SRV record
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GETDOMAINSRVHOSTS& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&ResponseType=XML
The response is as follows: 17217418 _imap _TCP imap.partnerdomain.com. SRV 0 50 10 1 17217420 _xmpp _UDP xmpp.partnerdomain.com. SRV 0 50 10 98 GETDOMAINSRVHOSTS eng 0
3/13/09
199
©2003-2009 Register.com, Inc.
API commands: GetDomainSRVHosts
0 1 10 RESELLERTEST rcom True True +03.00 0.047 true
Related commands GetDomainInfo GetHosts SetDomainSRVHosts SetHosts
3/13/09
200
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
OrderID
Recommended
Order ID of the most recent transaction for this domain
15
OrderType
Optional; default is Purchase
Type of order. Permitted values are Purchase (default), Transfer, or Extend
10
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
201
©2003-2009 Register.com, Inc.
API commands: GetDomainStatus
Returned parameters and values Param name Definition DomainName
Domain name
InAccount
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
StatusDesc
More detailed explanation of the InAccount value
ExpDate
Expiration date of the domain registration
OrderID
Order identification number of the most recent transaction for this domain
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.co.uk and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GETDOMAINSTATUS& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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: partnerdomain.co.uk 0 Awaiting Registry Response 156162742 GETDOMAINSTATUS 0 Test1 rcom False False true
3/13/09
202
©2003-2009 Register.com, Inc.
API commands: GetDomainStatus
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
203
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=GetDomainSubServices& uid=yourloginid&pw=yourpassword&sld=domain&tld=com
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
EmailForwarding
True, False or empty
HostRecords
True, False or empty
SetDomainServices
Successful or Failed
3/13/09
204
©2003-2009 Register.com, Inc.
Param name
Definition
API commands: GetDomainSubServices
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GetDomainSubServices& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The error count value of 0 confirms that hosts have been set successfully: E False True True GETDOMAINSUBSERVICES 0 Dev rcom true
Related commands ServiceSelect SetDomainSubServices
3/13/09
205
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size 20
UID
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain. For this command, value must be name. 15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DomainNameID
Domain name ID, Register.com’s internal accounting number
SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain. For this command, value is name.
Status
Status
3/13/09
206
©2003-2009 Register.com, Inc.
Param name
API commands: GetDotNameForwarding
Definition
Address
Email address to which email addressed to this domain is forwarded.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=getdotnameforwarding& uid=rcompartnerid&pw=rcompartnerpw&sld=john.doe&tld=name&responsetype=xml
The response is as follows: E False 1
[email protected] GETDOTNAMEFORWARDING 0 Reseller5 rcom False True true
Related commands Forwarding GetCatchAll GetForwarding GetPOP3 SetCatchAll SetDotNameForwarding
3/13/09
207
©2003-2009 Register.com, Inc.
API commands: GetExpiredDomains
GetExpiredDomains Description Definition Retrieve a list of an account’s 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DomainName
Domain name
DomainNameID
Domain name ID number, from our database
Status
Expiration status of this domain
Expiration-Date
Expiration date of this domain
LockStatus
Registrar lock status of this domain
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
208
©2003-2009 Register.com, Inc.
API commands: GetExpiredDomains
Param name
Definition
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid; identifies them as Expired, RGP, or Extended RGP status; and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getexpireddomains& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response is as follows: northwestcrafts.com 152139242 Extended RGP 2/26/2003 Locked fabrics-wallpaper.com 152134074 RGP 3/1/2003 6:54:40 AM Locked onlinebrochure.com 152129772 RGP 6/4/2002 6:18:36 PM Locked eweathervane.com 2062920 Expired 3/8/2002 2:14:45 AM Locked signonworldwide.com 2063248 Expired 3/8/2002 11:38:32 PM Locked
3/13/09
209
©2003-2009 Register.com, Inc.
API commands: GetExpiredDomains
Youcanhelp.net 152151738 Expired 3/7/2002 6:44:29 PM Locked ccpays.com 2082140 Extended RGP 4/26/2002 4:01:46 PM Locked . . . 120 GETEXPIREDDOMAINS en 0 0 10 RESELLERTEST rcom +0.00 1.503906 true
Related commands AddToCart Extend_RGP GetDomainInfo GetDomains PE_SetPricing Purchase
3/13/09
210
©2003-2009 Register.com, 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 in the return of this command, and permitted values for the Preconfigure command are tagged in the return for this command.
Availability All partners have access to this 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 country code must be valid.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition ID
ID number for our internal use
Name
Parameter name. Use this as the input parameter name in the Preconfigure command.
3/13/09
211
©2003-2009 Register.com, Inc.
API commands: GetExtAttributes
Param name Definition Value
Parameter value for the query string. Use this as the input parameter value in the Preconfigure command.
Title
Short definition of the parameter value
Application
Application. 2 indicates Registrant contact.
UserDefined
User must supply the value for this parameter from outside sources
Required
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 node of the parent.
Description
Extended definition of the parameter value
IsChild
If IsChild=1, this parameter is the child of another extended attribute.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=getextattributes& uid=rcompartnerid&pw=rcompartnerpw&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: 1 us_nexus 2 False 1 Nexus Category 0 12 C11 US Citizen A natural person who is a US Citizen
3/13/09
212
©2003-2009 Register.com, Inc.
API commands: GetExtAttributes
13 C12 Permanent Resident A natural person who is a Permanent Resident . . . 4 global_cc_us 2 False 0 Country 1 2 us_purpose 2 False 1 Application Purpose 0 17 P1 For Profit Business use for profit 18 P2 Non-profit Non-profit business, club, association, religious organization, etc. . . . GETEXTATTRIBUTES 0 Reseller3 rcom False True true
3/13/09
213
©2003-2009 Register.com, Inc.
API commands: GetExtAttributes
Related commands AddContact Contacts GetAddressBook GetContacts GetWhoisContact Preconfigure
3/13/09
214
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Expiration
Current expiration date.
MaxExtension
Maximum # of years that can be added.
CCAuthorized
Credit card transaction successfully authorized.
Price
Price for one-year extension for this type of TLD.
3/13/09
215
©2003-2009 Register.com, Inc.
Param name
API commands: GetExtendInfo
Definition
Balance
Current balance in this account.
AvailableBalance
Available balance in this account.
DefPeriod
Account-level setting for default renewal period for domain name registrations
AllowDNS
Account-level setting—True allows domain name servers other than Register.com’s
ShowPopups
Account-level setting—True shows popup menus
AutoRenew
Account-level setting—True automatically renews the domain registration 30 days before it expires
RegLock
Account-level setting—True requires the account holder’s permissiont to transfer the domain to another registrar
AutoPakRenew
Account-level setting—True automatically renews POP paks 30 days before they expire
UseDNS
Account-level setting—True uses Register.com’s name servers
ResellerStatus
Account-level setting—Reseller status of this account
RenewalSetting
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
RenewalBCC
Account-level setting— 1 Send blind carbon copy of renewal email to reseller 0 Do not send blind carbon copy to reseller
RenewalURLForward
Account-level setting—True automatically renews URL forwarding 30 days before the subscription expires
RenewalEmailForward
Account-level setting—True automatically renews email forwarding 30 days before the subscription expires
MailNumLimit
Account-level setting—True automatically renews email forwarding 30 days before the subscription expires
RCOMShield
Account-level setting—True automatically renews RCOM Shield 30 days before the subscription expires
DefRCOMShieldRenew
Account-level setting—True automatically renews RCOM Shield 30 days before the subscription expires
HostNameX
Account-level setting—Name of default host record
AddressX
Account-level setting—Default host record address
RecordTypeX
Account-level setting—Default host record type
DefaultHostRecordOwn
Account-level setting—By default, does this account assign user-defined host records?
UseOurDNS
Account-level setting—By default, does this account assign our DNS to domain names?
DNSX
Account-level setting—Default name servers
AcceptTerms
True has signed a credit card processing agreement with Register.com
URL
URL for reseller site, used in email notices
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
216
©2003-2009 Register.com, Inc.
API commands: GetExtendInfo
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 partnerdomain.com and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getextendinfo& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The response is as follows: False 06/25/2004 8 True 10.00 39.80 39.80 200 Command completed successfully GETEXTENDINFO 0 ResellerTest rcom true
Related commands Extend GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword InsertNewOrder SetPassword SetRegLock SetRenew StatusDomain UpdateExpiredDomains ValidatePassword
3/13/09
217
©2003-2009 Register.com, 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 partners have access to this 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 Register.com’s domain name servers.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
20
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
GetDefaultOnly
Optional
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.
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
218
©2003-2009 Register.com, Inc.
API commands: GetForwarding
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
UserNameX
Alias name to forward. Indexed X when ResponseType=Text or HTML.
Alias
Alias name to forward. Present when ResponseType=XML
ForwardToX
Email address to forward the alias to. Indexed X when ResponseType=Text or HTML.
Forward-To
Email address to forward the alias to. Present when ResponseType=XML
StatusX
Enabled status of email forwarding: 0 Email forwarding enabled 1 Email forwarding disabled Indexed X when ResponseType=Text or HTML.
EmailCount
Number of email forwarding records currently configured
MaxEmail
Total number of email forwarding records permitted for this domain name
EmailForwarding
True
HostRecords
True
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getforwarding& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The response is as follows: False jane.doe
[email protected] john.doe
[email protected] 2
3/13/09
219
©2003-2009 Register.com, Inc.
API commands: GetForwarding
GETFORWARDING 0 ResellerTest rcom true
Related commands DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetCatchAll GetDotNameForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetDotNameForwarding SetUpPOP3User
3/13/09
220
©2003-2009 Register.com, 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 company’s 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.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Optional
Second-level domain name (for example, register in register.com) for which you want fraud score information
63
EmailAddress
Required
Email address about which you want fraud information, 130 in format
[email protected]
CardNumber
Required
Credit card number, in 16-digit format
16
EndUserIP
Required
IP address of the end user, in format NNN.NNN.NNN.NNN
19
Country
Required
Country, in 2-letter country-code format
2
3/13/09
221
©2003-2009 Register.com, Inc.
API commands: GetFraudScore
Param name Obligation
Definition
Max size
ProductType
Product type, usually the product type this customer is trying to purchase. Permitted values are: domain a domain name No value all products except domains
7
ChargeAmount Required
Amount this customer is trying to charge, in format DD.cc
1000.00
Quantity
Required
Quantity of this product that customer is trying to purchase
2
ResponseType
Optional
Format of response. Options are Text (default), HTML, 4 or XML.
Optional; if this parameter is not included, the fraud score returned reflects all products except domains
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 company’s tolerance for risk.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=getfraudscore& uid=rcompartnerid&pw=rcompartnerpw&CardNumber=4111111111111111&sld=thisdomain&
[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: 80 GETFRAUDSCORE
3/13/09
222
©2003-2009 Register.com, Inc.
API commands: GetFraudScore
en 0 0 10 RESELLERTEST +0.00 2.351563 true
Related commands None
3/13/09
223
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RequestID
ID number of the request for the change described in this node
ReqDate
Time-stamp for this request
ReqTypeDesc
Description of the requested change
ReqStatusDesc Status of the requested change Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
224
©2003-2009 Register.com, Inc.
API commands: GetGlobalChangeStatus
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 rcompartnerid and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetGlobalChangeStatus& UID=rcompartnerid&PW=rcompartnerpw&ResponseType=XML
The response is as follows: 8332 9/2/2003 3:51:47 PM Registrar-lock on Open 8331 9/2/2003 3:51:47 PM Auto renew on Open 8326 8/29/2003 5:19:00 PM Auto renew on Open 8325 8/29/2003 5:19:00 PM Use Our DNS Open 8324 8/29/2003 5:18:59 PM Contact changes Open GETGLOBALCHANGESTATUS 0 RESELLERTEST rcom True True true
3/13/09
225
©2003-2009 Register.com, Inc.
API commands: GetGlobalChangeStatus
Related commands GetGlobalChangeStatusDetail
3/13/09
226
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
RequestID
Required
ID number for the global change to one parameter. Use the GetGlobalChangeStatus command to retrieve this value.
6
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition DomainName
Domain name
StatusDesc
Status of this change to this domain
ErrorDesc
Description of any error encountered during this change
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
227
©2003-2009 Register.com, Inc.
API commands: GetGlobalChangeStatusDetail
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GetGlobalChangeStatusDetail& UID=rcompartnerid&PW=rcompartnerpw&RequestID=8331&ResponseType=XML
The response is as follows: TestSLD1.biz Processed successfully none TestSLD2.com Processed successfully none TestSLD3.biz Processed successfully none TestSLD4.com Processed successfully none TestSLD5.com Processed successfully none TestSLD6.us Processed successfully none GETGLOBALCHANGESTATUSDETAIL 0
3/13/09
228
©2003-2009 Register.com, Inc.
API commands: GetGlobalChangeStatusDetail
Reseller2 rcom True True true
Related commands GetGlobalChangeStatus
3/13/09
229
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
StartPosition
Optional; default is 1
Return domain names beginning with this number. For example, if StartPosition=26&Display=25, display names 26 through 50 in the ordered list.
5
Display
Optional; default is 25
How many domain names to include in response. Permitted 100 values are 1 to 100.
OrderBy
Optional; default is SLD
Sort the response by this criterion. Permitted values are SLD, TLD, or RegStatus.
9
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition ID
Our numeric ID number for this domain
Name
Domain name
3/13/09
230
©2003-2009 Register.com, Inc.
API commands: GetHomeDomainList
Param name Definition RegStatus
Registration status
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GETHOMEDOMAINLIST& uid=rcompartnerid&pw=rcompartnerpw&display=25&orderby=tld&responsetype=xml
The response is as follows: 1 25 TLD, SLD 1 16 16 152542653 bajadazoo.biz Registered 152542655 tomalotamous.biz Registered 152544200 apophyleti.com Hosted 152542612 pangolineament.com Registered .
3/13/09
231
©2003-2009 Register.com, Inc.
API commands: GetHomeDomainList
. . 152542654 terraforaminifer.net Registered GETHOMEDOMAINLIST eng 0 0 10 RESELLERTEST rcom +0.00 0.125 true
Related commands AddToCart GetAllDomains GetDomains GetReport PurchaseServices
3/13/09
232
©2003-2009 Register.com, 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 partners have access to this 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 Register.com’s domain name servers.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Name
Host name of record.
Type
Record Type. Returns A, URL, MX, MXE, CNAME or FRAME.
MXPref
Preference level: the lower this value, the higher priority this service. Default value is 10.
3/13/09
233
©2003-2009 Register.com, Inc.
API commands: GetHosts
Param name Definition Address
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.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=gethosts& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The response lists the hosts: False 0 www A 127.0.0.1 @ A 127.0.0.1 mail MXE 10 127.0.0.1 GETHOSTS 0 ResellerTest rcom true
3/13/09
234
©2003-2009 Register.com, Inc.
API commands: GetHosts
Related commands GetMetaTag GetRegHosts GetSPFHosts SetDNSHost SetHosts SetSPFHosts UpdateMetaTag
3/13/09
235
©2003-2009 Register.com, 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 partners have access to this 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 Register.com’s domain name servers.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
HostNameX
Host name. For the GetMailHosts command, this is mail.DomainName.tld
RecordTypeX
Record type. Permitted values are MXE (email forwarding) or MX (POP3 mail).
AddressX
IP address of Register.com’s mail forwarding service.
3/13/09
236
©2003-2009 Register.com, Inc.
API commands: GetMailHosts
Param name Definition MXPrefX
Preference level: the lower this value, the higher priority this service. Default value is 10.
ServiceSelect
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
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getmailhosts& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The response is as follows: False True mail MXE 209.19.56.20 10 1051 GETMAILHOSTS 0 ResellerTest rcom true
3/13/09
237
©2003-2009 Register.com, Inc.
API commands: GetMailHosts
Related commands DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetForwarding GetPOP3 ModifyPOP3 PurchasePOPBundle SetUpPOP3User
3/13/09
238
©2003-2009 Register.com, Inc.
API commands: GetMetaTag
GetMetaTag Description Definition Retrieve the metatags for one of a domain’s host records.
Usage Use this command to retrieve the current metatags for one host record for a domain.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63 15
TLD
Required
Top-level domain name (extension)
MetaTagHostID
Required
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.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
TitleBar
Metatag content for browser title bar
SiteDescription
Metatag content for search engine results
Keywords
Metatag content for search engine keywords
DomainNameID
ID number for this domain, our internal tracking number
3/13/09
239
©2003-2009 Register.com, Inc.
Param name
Definition
API commands: GetMetaTag
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=getmetatag& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com& MetaTagHostID=11415002&ResponseType=XML
The response is as follows: E False MY COOL TITLE MY SITE DESCRIPTION MY SITE KEYWORDS 152533676 GETMETATAG 0 RESELLERTEST rcom False True true
Related commands GetHosts GetRegHosts SetHosts UpdateMetaTag
3/13/09
240
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
OrderID
Required
The identification number of the order for which you want details. You can retrieve this number using the GetOrderList command.
10
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
OrderID
9-digit order identification number.
Result
True/False -- True indicates that this order exists, and exists under this account.
BillDate
Time at which customer’s account was billed for the transaction amount.
3/13/09
241
©2003-2009 Register.com, Inc.
Param name
API commands: GetOrderDetail
Definition
CCRefNum
Credit card reference number for this transaction, generated by us.
ProductType
Description of this item.
Description
Description of the item. Return value is usually a domain name.
Status
Status for fulfilling the order for this item. Only a status Successful indicates that the Registry has registered this name to you.
Quantity
Number of years.
AmountPaid
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.
DomainPassword
Domain password, if one was assigned
OrderStatus
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.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GetOrderDetail& uid=rcompartnerid&pw=rcompartnerpw&orderid=156062775&responsetype=xml
The response indicates that in this order, the account successfully purchased 2 products: 156062775 True 7/19/2002 3:42:29 PM $35.80 Register partnerdomain2.net Successful 2 $17.90
3/13/09
242
©2003-2009 Register.com, Inc.
API commands: GetOrderDetail
Register partnerdomain3.info Successful 2 $17.90 GETORDERDETAIL 0 Dev Workstation rcom true
Related commands CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetDomainStatus GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory RPT_GetReport UpdateAccountInfo UpdateCusPreferences
3/13/09
243
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Start
Optional
Return sets of 25 records in reverse chronological order. For example, Start=26 returns the 26th through 50th most recent orders. Defaults to 1.
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
10
EndDate
Optional; if omitted, EndDate is today
End date of orders to return. Must be no more than six months after BeginDate. Permitted format is MM/DD/YYYY
10
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
244
©2003-2009 Register.com, Inc.
API commands: GetOrderList
Returned parameters and values Param name
Definition
OrderID
Order identification number, in nine-digit format.
OrderDate
Date on which the order was placed. Time stamp indicates the time at which our database received the order.
StatusDesc
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
OrderProcessFlag
True/False -- True indicates the order has been processed.
ShowPreviousAndNext
Yes/No -- Yes gives user access to previous and next transactions.
ShowPreviousLink
Yes/No -- Yes displays a link that calls the previous block of transactions.
PreviousStartPosition
First transaction to include in the response, counting back from the most recent, if user clicks the Previous link.
ShowStart
First transaction to include in the response, counting back from the most recent.
ShowEnd
Last transaction to include in the response, counting back from the most recent.
ShowNextLink
Yes/No -- Yes displays a link that calls the next block of transactions.
RecordCount
Total number of orders stored for this account.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid. 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://partnertest.rcomexpress.com/interface.asp?command=GetOrderList& uid=rcompartnerid&pw=rcompartnerpw&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:
3/13/09
245
©2003-2009 Register.com, Inc.
API commands: GetOrderList
156062752 7/19/2002 12:28:37 PM Order complete True 156062751 7/19/2002 12:15:27 PM Order complete True 156062750 7/19/2002 12:10:34 PM Order complete True . . . Yes Yes 1 26 37 No 37 GETORDERLIST 0 Dev Workstation rcom true
Related commands CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetReport GetSubAccountDetails GetSubAccounts GetTransHistory RPT_GetReport UpdateAccountInfo UpdateCusPreferences
3/13/09
246
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
PasswordSet
Returns 1 if a password is set, 0 otherwise.
DomainPassword
If PasswordSet=1, then a password is returned in this parameter.
Command
Name of command executed
3/13/09
247
©2003-2009 Register.com, Inc.
API commands: GetPasswordBit
Param name
Definition
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getpasswordbit& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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. False userpw 1 GETPASSWORDBIT 0 ResellerTest rcom true
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
248
©2003-2009 Register.com, 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 domain’s POP paks.
Availability All partners have access to this 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 Register.com’s domain name servers.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
GetDefaultOnly Optional
If this is set to 1, extra blank input records are returned for user input on the POP3 form. Primarily used in XML output.
1
ResponseType
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
Optional
249
©2003-2009 Register.com, Inc.
API commands: GetPOP3
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
EmailCount
Number of email accounts on the domain name.
UsernameX
POP user name for this email account (this mailbox). Indexed X = 1 to EmailCount if ResponseType=text or HTML.
PasswordX
POP password name for the email account. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
QuotaX
Maximum storage capacity for each mailbox, in megabytes. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
ExpDateX
Expiration date of the POP3 account. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
BundleIDX
ID number of this POP pak. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
AutoRenewX
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.
QuotaUsedX
Number of MB of storage space currently in use for this account. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
[Pak]BundleIDX
ID number of this POP pak. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML.
[Pak]QtyPurchasedX
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.
[Pak]QtyAvailableX
Total number of POP accounts currently configured for this domain name. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML.
[Pak]ExpDateX
Expiration date of this POP pak. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML.
[Pak]AutoRenewX
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.
[Pak]QuotaX
Maximum storage capacity for each mailbox, in megabytes. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
3/13/09
250
©2003-2009 Register.com, Inc.
API commands: GetPOP3
Example The following query requests a list of all POP mail accounts in partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getpop3& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The response lists the five POP mail accounts that belong to partnerdomain.com. Four are part of bundle 5105 and one is from bundle 5134: False jane janepw 1024 7/26/2003 3:48:15 PM 1 5105 john johnpw 1024 7/26/2003 3:48:15 PM 1 5105 john.doe johndoe 1024 7/26/2003 3:48:15 PM 1 5105 test8 test8 1024 7/26/2003 3:48:15 PM 1 5105 james rcompartnerpw 1024 8/15/2003 11:01:30 AM 1 5134 5 5105 10 6 7/26/2003 3:48:15 PM 1
3/13/09
251
©2003-2009 Register.com, Inc.
API commands: GetPOP3
5134 10 9 8/15/2003 11:01:30 AM 1 2 GETPOP3 0 ResellerTest rcom true
Related commands DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetCatchAll GetForwarding GetMailHosts GetPOPExpirations GetPOPForwarding ModifyPOP3 PurchasePOPBundle RenewPOPBundle SetPakRenew SetPOPForwarding SetUpPOP3User
3/13/09
252
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition DomainX
Domain name with which this POP pak is associated. The response is indexed X if ResponseType=text or HTML.
BundleIDX
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.
ExpDateX
Expiration date of this POP pak. The response is indexed X if ResponseType=text or HTML.
3/13/09
253
©2003-2009 Register.com, Inc.
API commands: GetPOPExpirations
Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GetPOPExpirations& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
In the response, the list of POP paks and the ErrCount value 0 confirm that the query was successful: partnerdomain.com 5105 7/26/2003 3:48:15 PM partnerdomain.com 5134 8/15/2003 11:01:30 AM partnerdomain.com 5735 5/14/2004 4:20:40 PM 3 GETPOPEXPIRATIONS en 0 0 1 10 RESELLERTEST rcom True True 8.984375E-02 true
3/13/09
254
©2003-2009 Register.com, Inc.
API commands: GetPOPExpirations
Related commands Extend GetPOP3 GetRenew Purchase PurchasePOPBundle RenewPOPBundle
3/13/09
255
©2003-2009 Register.com, Inc.
API commands: GetPOPForwarding
GetPOPForwarding Description Definition Retrieve the email forwarding record—either POP or our email forwarding—for a specified mailbox name.
Usage Use this command to retrieve the email forwarding record for a specified mailbox user name.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63 15
TLD
Required
Top-level domain name (extension)
UserName
Required
Mailbox name (for example, john in
[email protected]) 50
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DomainName
Domain SLD and TLD
DomainNameID
Numeric domain name ID, from our database
UserName
Mailbox name
ForwardTo
Email forwarding address
3/13/09
256
©2003-2009 Register.com, Inc.
API commands: GetPOPForwarding
Param name
Definition
Active
Is this forwarding address active? 1 indicates yes.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GETPOPFORWARDING& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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: E False partnerdomain.com 152533676 Y
[email protected] 1 GETPOPFORWARDING en 0 0 1 10 RESELLERTEST rcom True True +03.00 0.1132813 true
3/13/09
257
©2003-2009 Register.com, Inc.
API commands: GetPOPForwarding
Related commands DeletePOP3 GetCatchAll GetPOP3 PurchasePOPBundle SetPOPForwarding SetUpPOP3User
3/13/09
258
©2003-2009 Register.com, 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 partners have access to this 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 Register.com’s domain name servers.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ExtFormat
Optional
ExtFormat=1 encloses the repeating host information in a separate tag so it is easier to parse.
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
HostIDX
Identification number of this individual host record
3/13/09
259
©2003-2009 Register.com, Inc.
API commands: GetRegHosts
Param name Definition HostNameX
Name of this individual host record
AddressX
Address of this individual host record
RecordTypeX
Record type of this individual host record
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=getreghosts& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&ExtFormat=1& responsetype=xml
The response is as follows: www CNAME 16139887 @ (none) 66.150.5.189 A 16139888 photos photos.msn.com. CNAME . . . * (other)
3/13/09
260
©2003-2009 Register.com, Inc.
API commands: GetRegHosts
CNAME False 1114 GETREGHOSTS eng 0 0 1 10 RESELLER1-STG rcom True True +03.00 0.406 true
Related commands GetHosts GetMetaTag SetDNSHost SetHosts UpdateMetaTag
3/13/09
261
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
RegistrationStatus
Registration Status of the Domain name. Options are Processing, Registered, Hosted, Null.
PurchaseStatus
Purchase status of the Domain name. Options are Processing, Paid, Null.
Command
Name of command executed
3/13/09
262
©2003-2009 Register.com, Inc.
API commands: GetRegistrationStatus
Param name
Definition
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com is registered and paid for, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getregistrationstatus& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The response is as follows: False Registered GETREGISTRATIONSTATUS 0 ResellerTest rcom true
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
263
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
RegLock
Returns 1 if locked, 0 otherwise if the responsetype is Text.
RRPCode
Response code from Registry.
RRPText
Response text from Registry.
Command
Name of command executed
3/13/09
264
©2003-2009 Register.com, Inc.
API commands: GetRegLock
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
IsLockable
Indicates whether this TLD can use the Registrar Lock feature. Return values are True or False.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query requests the lock status of a domain name, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getreglock& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
In the response, the reg-lock value of 1 indicates that the domain name is locked: False 1 200 Command completed successfully GETREGLOCK 0 ResellerTest rcom true
3/13/09
265
©2003-2009 Register.com, Inc.
API commands: GetRegLock
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
266
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
RenewName
Returns 1 if this domain is set to auto-renew, 0 otherwise.
PakExist
Returns 1 if there are POP paks associated with this domain, 0 otherwise.
3/13/09
267
©2003-2009 Register.com, Inc.
Param name
API commands: GetRenew
Definition
AutoPakRenew
Returns 1 if the POP paks for this domain are set to auto-renew, 0 otherwise.
EMailFwdExists
Returns 1 if this domain subscribes to email forwarding, 0 otherwise.
EMailForwardRenew
Returns 1 if the email forwarding for this domain is set to auto-renew, 0 otherwise.
URLFwdExists
Returns 1 if this domain subscribes to URL forwarding, 0 otherwise.
URLForwardRenew
Returns 1 if the URL forwarding for this domain is set to auto-renew, 0 otherwise.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getrenew& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
In the response, the auto-renew value of 1 indicates that the domain is set to automatically renew: False 1 GETRENEW 0 ResellerTest rcom true
3/13/09
268
©2003-2009 Register.com, 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
3/13/09
269
©2003-2009 Register.com, Inc.
API commands: GetReport
GetReport Description Definition Get a report on a user’s 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
FName
First (use) name of the account registrant.
LName
Last (family) name of the account registrant.
Party
Party identification number. Format is 32 hexadecimal digits, hyphenated.
DN
Domain name parameter.
DomName
Domain name attribute.
NSStatus
Name server status. Value yes indicates our name servers. Value no indicates not our name servers.
3/13/09
270
©2003-2009 Register.com, Inc.
API commands: GetReport
Param name
Definition
RegistrationStatus
Registration status in this account. Return values are: Deleted Domain has been deleted from registrar’s database. Expired Domain registration has expired but has not been deleted from registrar’s 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.
ExpirationDate
Date on which this domain registration expires.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getreport& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
In the response, the ReportDetail section lists the domains in account rcompartnerid: John Doe {BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}
3/13/09
271
©2003-2009 Register.com, Inc.
API commands: GetReport
GETREPORT 0 ResellerTest rcom true
Related commands CheckLogin CreateAccount CreateSubAccount GetAllAccountInfo GetAccountPassword GetAllAccountInfo GetHomeDomainList GetOrderDetail GetOrderList GetSubAccountDetails GetSubAccounts GetTransHistory RPT_GetReport UpdateAccountInfo UpdateCusPreferences
3/13/09
272
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
OrganizationName
Reseller organization name
FName
Reseller first name
LName
Reseller last name
Address1
Address first line
Address2
Address second line
City
City
3/13/09
273
©2003-2009 Register.com, Inc.
Param name
Definition
StateProvince
Name of state or province
API commands: GetResellerInfo
StateProvinceChoice
S indicates StateProvince is a state; P, a province
PostalCode
Postal code
Country
Two-letter country code
Phone
Phone number
Fax
Fax number
EMailAddress
Email address
PhoneExt
Phone extension
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=GetResellerInfo& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The response is as follows: Partner Domains Inc. John Doe 111 Main St. Hometown NY S 99999 US 5555555555 5555555556
[email protected] GETRESELLERINFO 0 RESELLERTEST rcom
3/13/09
274
©2003-2009 Register.com, Inc.
API commands: GetResellerInfo
True True true
Related commands AddContact GetAccountInfo GetAddressBook GetAllAccountInfo GetContacts GetWhoisContact
3/13/09
275
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Name
Name of this SPF record
Type
Type of this SPF record
A-Radio
Setting for A-radio
MX-Radio
Setting for MX-radio
PTR-Radio
Setting for PTR-radio
ALL-Radio
Setting for ALL-radio
3/13/09
276
©2003-2009 Register.com, Inc.
API commands: GetSPFHosts
Param name Definition A-Records
Value for A records
MX-Records
Value for MX records
IP-Records
Value for IP records
INC-Records
Value for INC record
HostID
Host ID number
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=getspfHosts& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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: E False test TXT off on on on regular hostnames po mx servers to 127.0.0.1 myisp.net mydomain.com 15195981 GETSPFHOSTS en 0 0 1 10 RESELLERTEST rcom True
3/13/09
277
©2003-2009 Register.com, Inc.
API commands: GetSPFHosts
True +03.00 0.171875 true
Related commands GetHosts SetHosts SetSPFHosts
3/13/09
278
©2003-2009 Register.com, 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.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Service
Optional
If the Service parameter is omitted, the Billing contact information is returned.
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Organization
Name of contact’s organization
Address1
Contact address, line 1
Address2
Contact address, line 2
City
Contact’s city
StateProvince
Contact’s state or province
PostalCode
Contact’s postal code
Country
Contact’s country
3/13/09
279
©2003-2009 Register.com, Inc.
API commands: GetServiceContact
Param name Definition Phone
Contact’s phone number
Fax
Contact’s fax number
EmailAddress
Contact’s email address
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GETSERVICECONTACT& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
In the response, the presence of contact information, and the ErrCount value 0, indicate that the query was successful: Partner Domains Inc. 111 Main St. Hometown NY 99999 US +1.5555555555 +1.5555555556
[email protected] GETSERVICECONTACT en 0 0 1 10 RESELLERTEST rcom True True 8.203125E-02 true
3/13/09
280
©2003-2009 Register.com, Inc.
API commands: GetServiceContact
Related commands AddContact Contacts GetAddressBook GetContacts GetWhoisContact
3/13/09
281
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Account
Required
Subaccount ID number, in NNN-aa-NNNN format. You can retrieve this number using the GetSubAccounts command.
20
3/13/09
282
©2003-2009 Register.com, Inc.
API commands: GetSubAccountDetails
Param name
Obligation
Definition
Max size
Action
Optional; default value is List
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.
20
UseQtyEngine
Optional
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.
AcctType
Required if Action=Manage
Account type. Permitted values are Reseller or Retail.
20
TLDPrice
Required for every TLD we offer if Action=Manage. If any TLDs are missing, the query fails.
Price for registering a .com domain. Permitted format is DD.cc
20
TLDRenew
Required for every TLD we offer if Action=Manage. If any TLDs are missing, the query fails.
Price for renewing a TLD domain. Permitted format is DD.cc
20
TLDTransfer
Required for every TLD we offer if Action=Manage. If any TLDs are missing, the query fails.
Price for transferring a TLD domain. Permitted format is DD.cc
20
POP3
Required if Action=Manage
Price for a POP Email pak. Permitted format is DD.cc
20
WPPS
Required if Action=Manage
Price for RCOM Shield. Permitted format is 20 DD.cc
DotNameBundle
Required if Action=Manage
Price for a dot-name bundle (the domain 20 name with email provided by the dotname Registry). Permitted format is DD.cc
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
Action
If MANAGE is in the response, prices have been changed to those listed.
SubAccount
Subaccount ID number, in NNN-aa-NNNN format.
3/13/09
283
©2003-2009 Register.com, Inc.
API commands: GetSubAccountDetails
Param name
Definition
PartyID
Party identification number expressed as 32 hexadecimal characters, hyphenated.
LoginID
Account ID of the subaccount.
DomainCount
Number of domains in this subaccount.
Account
Subaccount ID number, in NNN-aa-NNNN format.
TLD
Top-level domain; for example, com for .com domains.
RegisterPrice
Price for registering a domain of this type for one year.
RegisterEnabled
True/False—True indicates that this subaccount allows customers to register domain names.
RenewPrice
Price for renewing a domain of this type for one year.
RenewEnabled
True/False -- True indicates that this subaccount allows customers to renew domain names.
TransferPrice
Price for transferring a domain of this type, and paying for one year of registration.
TransferEnabled
True/False -- True indicates that this subaccount allows customers to transfer domain names.
POP3
Price for one 10-mailbox POP pak, per year, in $US
DotNameBundle
Price for a one-year registration of a .name domain, with the .name Registry’s email forwarding
DNSHosting
Price for one year of DNS hosting
WPPS
Price for one year of RCOM Shield
Certificate-GeoTrust-QuickSSL-Premium
Price for one year registration of a GeoTrust QuickSSL Premium SSL certificate
Certificate-GeoTrust-TrueBizID
Price for one year registration of a GeoTrust True BusinessID SSL certificate
Certificate-GeoTrust-TrueBizID-EV
Price for one year registration of a GeoTrust True BusinessID EV certificate
Certificate-GeoTrust-QuickSSL
Price for one year registration of a GeoTrust QuickSSL certificate
Certificate-GeoTrust-TrueBizID-Wildcard
Price for one year registration of a GeoTrust True BusinessID Wildcard SSL certificate
Certificate-RapidSSL-RapidSSL
Price for one year registration of a RapidSSL certificate
Certificate-VeriSign-Secure-Site
Price for one year registration of a VeriSign Secure Site SSL certificate
Certificate-VeriSign-Secure-Site-Pro
Price for one year registration of a VeriSign Secure Site PRO SSL certificate
Certificate-VeriSign-Secure-Site-EV
Price for one year registration of a VeriSign Secure Site Extended Validation SSL certificate
Certificate-VeriSign-Secure-Site-Pro-EV
Price for one year registration of a VeriSign Secure Site Pro with Extended Validation SSL certificate
LWSC-Basic
Price for one month of Web Site Creator Basic
LWSC-Full
Price for one month of Web Site Creator Full
LWSC-Ecommerce
Price for one month of Web Site Creator eCommerce
Hosted-Exchange-Mailbox
Price for one Hosted Microsoft Exchange mailbox, per month
Hosted-Exchange-Extra-Storage
Price for 100MB of extra storage pooled among all mailboxes in this Hosted Microsoft Exchange account, per month
3/13/09
284
©2003-2009 Register.com, Inc.
API commands: GetSubAccountDetails
Param name
Definition
Hosted-Exchange-BlackBerry
Price for delivery to one BlackBerry device, per month
Hosted-Exchange-BlackBerry-Setup-Fee
One-time charge for setting up BlackBerry service for one device
Hosted-Exchange-GoodLink
Price for delivery to one Good Mobile Messaging device, per month
Hosted-Exchange-GoodLink-Setup-Fee
One-time charge for setting up Good Mobile Messaging service for one device
Hosted-Exchange-ActiveSync
Price for delivery to one ActiveSync device, per month
DNSHostingRenew
Price to renew one year of DNS hosting
RGP
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.
ExtendedRGP
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.
POPStorage
Price for one unit of extra POP storage, for one year
POPStorageRenew
Price to renew one year of extra POP storage, for one year
POPRenew
Price to renew POP service for one year, for one 10mailbox POP pak
DotNameEmail
Price for one year of email forwarding by the .name Registry, for one domain name
DotNameRegMailRenew
Price to renew one year of registration and email forwarding by the .name Registry
EmailForwardingRenew
Price to renew our email forwarding service, for one year and one domain name
URLForwardingRenew
Price to renew our URL forwarding service, for one year and one domain name
WPPSRenew
Price to renew RCOM Shield for one year, for one domain
ProductType
Product ID number
Product
Product name
ProductEnabled
Enabled status of this product
Price
Price of this product. Both Email Forwarding and URL Forwarding are yearly subscriptions.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
3/13/09
285
©2003-2009 Register.com, Inc.
API commands: GetSubAccountDetails
Example The following query requests for a subaccount of rcompartnerid, 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://partnertest.rcomexpress.com/interface.asp?Command=GETSUBACCOUNTDETAILS& uid=rcompartnerid&pw=rcompartnerpw&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: MANAGE 154-dz-5567 retail 19 20 21 19 20 21 19 20 21 . . . {8D504DD5-C773-41C4-83F6-4495CA479103} giambi 3 154-dz-5567 0 com 19 True 20 True 21 True net 19 True 20 True
3/13/09
286
©2003-2009 Register.com, Inc.
API commands: GetSubAccountDetails
21 True org 19 True 20 True 21 True . . . GETSUBACCOUNTDETAILS 0 Dev Workstation rcom true
Related commands CheckLogin CreateAccount CreateSubAccount DeleteSubaccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetConfirmationSettings GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccounts GetSubaccountsDetailList GetTransHistory UpdateAccountInfo UpdateCusPreferences
3/13/09
287
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
288
©2003-2009 Register.com, Inc.
API commands: GetSubAccountPassword
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetSubAccountPassword& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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. GETSUBACCOUNTPASSWORD 0 Dev Workstation rcom true
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew SetPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
289
©2003-2009 Register.com, Inc.
API commands: GetSubAccounts
GetSubAccounts Description Definition List subaccounts.
Usage Use this command to list subaccounts for an account.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
ListBy
Optional
Sorting parameter. Options are LName, EMailAddress, LoginID.
12
StartLetter
Optional
First letter of the ListBy value
1
StartPosition
Optional
First return value in the list generated with the ListBy and StartLetter parameters. Maximum number of subaccounts returned per query is 25.
7
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition PartyID
Party identification number expressed as 32 hexadecimal characters, hyphenated
LoginID
Login ID of the subaccount
DomainCount
Number of domains in this subaccount
Account
Subaccount ID number in NNN-aa-NNNN format.
3/13/09
290
©2003-2009 Register.com, Inc.
API commands: GetSubAccounts
Param name Definition Reseller
Reseller=0 indicates that this subaccount is a retail account; Reseller=1 indicates this subaccount is a reseller account
Count
Number of subaccounts in this account that fit the ListBy and StartLetter criteria
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid. 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://partnertest.rcomexpress.com/interface.asp?command=getsubaccounts& uid=rcompartnerid&pw=rcompartnerpw&ListBy=LName&StartLetter=D&StartPosition=7& responsetype=xml
The response indicates that account rcompartnerid has 12 subaccounts that fit the parameters, and returns the seventh through twelfth subaccounts in that list: {AFCFAEC0-2FB6-4512-B043-EE6653618E1F} resellsub 0 030-hi-7080 0 john doe
[email protected] . . . {C5D65CB8-1522-422A-9B78-D004AF13ADF0} testok 0 850-tn-1053 0 1 GETSUBACCOUNTS
3/13/09
291
©2003-2009 Register.com, Inc.
API commands: GetSubAccounts
0 ResellerTest rcom true
Related commands CheckLogin CreateAccount CreateSubAccount DeleteContact DeleteSubaccount GetAccountInfo GetAccountPassword GetAccountValidation GetAllAccountInfo GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubaccountsDetailList GetTransHistory UpdateAccountInfo UpdateCusPreferences
3/13/09
292
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
LoginID
Subaccount ID
FName
First name of the subaccount owner
LName
Last name of the subaccount owner
EMailAddress
Email address of the subaccount owner
OrganizationName
Organization of the subaccount owner
URL
URL of the subaccount owner’s business
JobTitle
Job title of the subaccount owner
Address1
Street address of the subaccount owner’s address, first line
Address2
Street address of the subaccount owner’s address, second line
City
Subaccount owner’s city
3/13/09
293
©2003-2009 Register.com, Inc.
Param name
Definition
API commands: GetSubaccountsDetailList
StateProvince
Subaccount owner’s state or province
PostalCode
Subaccount owner’s postal code
Country
Subaccount owner’s country
Phone
Subaccount owner’s phone number
Fax
Subaccount owner’s fax number
PhoneExt
Extension of subaccount owner’s phone number
Reseller
Reseller status. 1 indicates this is a reseller subaccount; 0 indicates retail.
Password
If this is a retail account, the account password
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, with owners’ contact information, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetSubaccountsDetailList& uid=rcompartnerid&pw=rcompartnerpw&ResponseType=xml
The response is a list of subaccounts with the owner information: john doe
[email protected] Partner Domains Inc. Tester 111 Main St. Hometown NY 99999 US 9995559999 9995559998
3/13/09
294
©2003-2009 Register.com, Inc.
API commands: GetSubaccountsDetailList
giambi John Doe
[email protected] Partner Domains Inc. Tester 111 Main St. Hometown NY 99999 US 9995559999 9995559998 . . . testok John Doe
[email protected] Partner Domains Inc. Tester 111 Main St. Hometown NY 99999 US 9995559999 9995559998 15 GETSUBACCOUNTSDETAILLIST 0 RESELLERTEST rcom True True true
Related commands GetSubAccountDetails GetSubAccounts GetAccountValidation SubAccountDomains
3/13/09
295
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition TLDX
Top-level domain name (extension). If ResponseType=text or html, each entry is indexed X.
TLDCount
Number of TLDs listed in this response (that is, the number of TLDs authorized by this account)
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
296
©2003-2009 Register.com, Inc.
API commands: GetTLDList
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=gettldlist& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response is as follows: com net org us info biz co.uk org.uk de 9 GETTLDLIST en 0 0
3/13/09
297
©2003-2009 Register.com, Inc.
API commands: GetTLDList
10 RESELLERTEST 0.140625 true
Related commands AuthorizeTLD PE_SetPricing RemoveTLD SetResellerTLDPricing
3/13/09
298
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
StartPosition
Optional; default is 1
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.
StartDate
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
10
EndDate
Optional; default is today’s date
End date of transactions to return. Must be no more than six months after StartDate. Permitted format is MM/DD/YYYY
10
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
299
©2003-2009 Register.com, Inc.
API commands: GetTransHistory
Returned parameters and values Param name
Definition
AdjustedBeginDate
Start date for this response
AdjustedEndDate
End date for this response
FName
First (given) name
LName
Last (family) name
PartyID
Party identification number. Format is 32 hexadecimal characters, hyphenated, in curly braces
CurrentStartPosition
Start position of this response, in the reverse chronological list of transactions
RecordCount
Number of transactions in the transaction history
NewStartPosition
Start position of the next response, in the reverse chronological list of transactions
OldStartPosition
Start position of the previous response, in the reverse chronological list of transactions
Trans-Date
Time stamp indicates when the transaction was submitted to our accounting system
Amount
Amount of the transaction, $US
TransDescription
Word description of this transaction
TransType
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 22 Reverse Commission 23 Reverse Commission with Charge Back 26 Activation Fee 28 Refill Service Convenience Charge 32 Refill Reseller Account (No Service Charge)
LinkValue
Used in XML to build links to individual orders.
OrderID
Order identification number, a nine-digit number
OrderProcessFlag
True indicates the order has been successfully processed.
Balance
Balance in the account following this transaction.
ComBalance
Commission balance following this transaction.
TransStatus
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)
Command
Name of command executed
Language
Language
3/13/09
300
©2003-2009 Register.com, Inc.
API commands: GetTransHistory
Param name
Definition
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
ResponseCount
Response count
MinPeriod
Minimum registration period, for domain name purchases
MaxPeriod
Maximum registration period, for domain name purchases
Server
Name of server
Site
Name of site
IsLockable
Is this a lockable domain name?
IsRealTimeTLD
Is this a TLD that supports real-time purchase?
TimeDifference
Time difference between end user and our server
ExecTime
Time to execute this API query
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query requests the transaction history for account rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetTransHistory& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
By default, the response gives a summary of the 25 most recent transactions: John Doe {BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629} 1 396 26 0 7/18/2007 1:25:11 PM -$4.40 Order 1 OrderDetail.asp?OrderID=157385793&OrderProcess=Successful 157385793 True
3/13/09
301
©2003-2009 Register.com, Inc.
API commands: GetTransHistory
$7,028.39 Successful 7/16/2007 2:05:01 AM -$8.95 Order 1 OrderDetail.asp?OrderID=157385407&OrderProcess=Successful 157385407 True $7,032.79 Successful . . . GETTRANSHISTORY eng 0 0 10 RESELLER1-STG rcom +0.00 0.750 true
Related commands CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts RefillAccount RPT_GetReport UpdateAccountInfo UpdateCusPreferences
3/13/09
302
©2003-2009 Register.com, 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 Register.com or its resellers.
Availability All partners have access to this 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://partnertest.rcomexpress.com/ interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
ContactType
Type of contact data being returned
RegistrantOrganization
Organization information
RegistrantFName
First name
3/13/09
303
©2003-2009 Register.com, Inc.
API commands: GetWhoisContact
Param name
Definition
RegistrantLName
Last name
RegistrantAddress1
Address line 1
RegistrantAddress2
Address line 2
RegistrantCity
City
RegistrantStateProvince
State or province
RegistrantPostalCode
Postal Code
RegistrantCountry
Country
RegistrantPhone
Phone number
RegistrantFax
Fax number
RegistrantEmailAddress
Email address
Whoisregistrar
Registrar for the name
Whoisupdated-by
Registrar that last updated the Whois info
Whoisstatus
Status of the name
Whoisupdated-date
Date of last update
Whoiscreated-date
Creation date for the name
Whoisregistration-expiration-date
Current expiration date
Whoiscreated-by
Registrar that created the information for the name
WhoisnameserverCount
Number of name servers associated with this name
WhoisnameserverX
Name servers. Indexed X when ResponseType=Text or HTML.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=getwhoiscontact& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The response is as follows: False
3/13/09
304
©2003-2009 Register.com, Inc.
API commands: GetWhoisContact
partnerdomain.com 'Partner Domains Inc.' John Doe '111 Main St.' 'Hometown' 'UNITED STATES' '555-555-5555'
[email protected] . . . . . . . . . . . . True . . .
Related commands AddContact Contacts GetAddressBook GetContacts GetExtAttributes GetResellerInfo GetServiceContact Preconfigure
3/13/09
305
©2003-2009 Register.com, Inc.
API commands: GetWPPSInfo
GetWPPSInfo Description Definition Retrieve the RCOM Shield (Whois privacy protection) status and contact information for a domain name.
Usage Use this command to retrieve RCOM Shield status for a domain name.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
DomainName
Domain name
SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain name (extension)
DomainNameID
Domain name ID number, from our database
WPPSAllowed
Whether RCOM Shield is available for this TLD
WPPSExists
Whether this domain has an RCOM Shield subscription
3/13/09
306
©2003-2009 Register.com, Inc.
API commands: GetWPPSInfo
Param name
Definition
WPPSEnabled
Whether RCOM Shield is enabled for this domain
WPPSExpDate
Expiration date for this domain’s RCOM Shield subscription
WPPSAutoRenew
Whether auto-renew is enabled for this domain’s RCOM Shield subscription
WPPSPrice
Yearly fee for this domain’s RCOM Shield subscription
ContactType
The contact type for this set of contact information
Organization
The organization name for this contact
FName
First name for this contact
LName
Last name for this contact
Address1
Address, first line, for this contact
Address2
Address, second line, for this contact
City
City for this contact
StateProvince
State or province for this contact
PostalCode
Postal code for this contact
Country
Country for this contact
Phone
Phone number for this contact
Fax
Fax number for this contact
EmailAddress
Email address for this contact
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query requests RCOM Shield settings for partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=GetWPPSInfo& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&ResponseType=XML
In the response, the RCOM Shield status information, and the ErrCount value 0, confirm that the query was successful: partnerdomain.com 1 1 1 Nov 26, 2004
3/13/09
307
©2003-2009 Register.com, Inc.
API commands: GetWPPSInfo
No $6.00 Partner Domains Inc. John Doe 111 Main St. Hometown NY 99999 US +1.5555555555 +1.5555555556
[email protected] . . . Whois Privacy Protection Service, Inc. Whois Agent PMB 368, 14150 NE 20th St - F1 C/O partnerdomain.com Hometown NY 99999 US +1.4252740657 +1.4256960234
[email protected] GETWPPSINFO en 0 0 1 10 RESELLERTEST rcom True True 0.140625 true
Related commands DisableServices EnableServices PurchaseServices ServiceSelect
3/13/09
308
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
UID
Required
Account login ID
20
PW
Required
Account password
20
Account
Required
Name of Hosted Microsoft Exchange account to be 10 deleted. Permitted format is HXNNNNN
Enable
Optional; default is True
1 Should this Hosted Microsoft Exchange account remain active? Permitted values are False (disable immediately) or True (leave enabled).
Delete
Optional; default is False
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
3/13/09
Definition
Max size
309
©2003-2009 Register.com, Inc.
Param name
Obligation
API commands: HE_CancelAccount
Definition
Max size
DropDownReason Required if Delete=True
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
1
FreeFormReason
Required if Delete=True
User-supplied text explaining cancellation
250
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
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
Cancel
Is this account now flagged for deletion at the end of the current billing period?
Success
Was this query successful?
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=HE_CANCELACCOUNT& uid=rcompartnerid&pw=rcompartnerpw&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: 1 True true
3/13/09
310
©2003-2009 Register.com, Inc.
API commands: HE_CancelAccount
HE_CANCELACCOUNT eng 0 0 10 RESELLER1-STG rcom +0.00 0.391 true
Related commands HE_ChangePassword HE_CreateAccount HE_GetAccountDetails HE_GetAccounts HE_GetPricing HE_UpgradeAccount
3/13/09
311
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Account
Required
Hosted Microsoft Exchange account name. Permitted format is HXNNNNN
12
NewPW
Required
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 ! @ $ ^ * ( ) _ = - [ ] |
14
ConfirmNewPW
Required
Repeat the new password for your Hosted Microsoft Exchange account name
14
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
312
©2003-2009 Register.com, Inc.
API commands: HE_ChangePassword
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
Success
True indicates that the query was successful.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=HE_ChangePassword& uid=rcompartnerid&pw=rcompartnerpw&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: 0 True HE_CHANGEPASSWORD eng 0 0 10 RESELLER1-STG rcom +0.00 0.469 true
3/13/09
313
©2003-2009 Register.com, Inc.
API commands: HE_ChangePassword
Related commands HE_CancelAccount HE_CreateAccount HE_GetAccountDetails HE_GetAccounts HE_GetPricing HE_UpgradeAccount
3/13/09
314
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID PW
Required
Account login ID
20
Required
Account password
20
SLD
Required
Second-level domain name to associate with this Hosted Microsoft Exchange account.
63
TLD
Required
Top-level domain name (extension)
15
MailboxQty
Required
Number of mailboxes to support. Permitted values are 1 3 to 255.
ExtraStorageQty
Required
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.
BlackBerryQty
Required
Number of BlackBerry devices to support. Permitted values are 0 to 255.
3/13/09
3
315
©2003-2009 Register.com, Inc.
API commands: HE_CreateAccount
Param name
Obligation
Definition
Max size
GoodLinkQty
Required
Number of Good Mobile Messaging devices to support. Permitted values are 0 to 255.
3
ActiveSyncQty
Required
Number of Microsoft ActiveSync devices to support. Permitted values are 0 to 255.
3
ResponseType
Optional
Format of response. Options are Text (default), HTML, 4 or XML.
Returned parameters and values Param name
Definition
Mailboxes
Number of Hosted Microsoft Exchange mailboxes purchased in this order
BlackBerrys
Number of BlackBerry subscriptions purchased in this order
GoodLinks
Number of Good Mobile Messaging subscriptions purchased in this order
ActiveSyncs
Number of ActiveSync subscriptions purchased in this order
ExtraStorage
Number of extra storage units purchased in this order
TotalPrice
Total charges for this order
SMTPProxy
SMTP proxy address for this Hosted Microsoft Exchange account
AccountID
Hosted Microsoft Exchange account identification number, used by the Exchange servers to identify this account
HostedExchangeLoginID
Login ID for this Hosted Microsoft Exchange account, used for most management and access tasks
HostedExchangePassword
Login password for this Hosted Microsoft Exchange account, used for most management and access tasks
OrderID
Order ID for this purchase
Success
Success status for this purchase
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query purchases Hosted Microsoft Exchange and add-ons, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=HE_CreateAccount& uid=rcompartnerid&pw=rcompartnerpw&SLD=partnerdomain&TLD=com&MailboxQty=7& ExtraStorageQty=6&BlackBerryQty=3&GoodLinkQty=2&ActiveSyncQty=1&responsetype=xml
3/13/09
316
©2003-2009 Register.com, Inc.
API commands: HE_CreateAccount
In the response, a Hosted Microsoft Exchange account name, and an ErrCount value 0, confirm that the query was successful: 7 3 2 1 6 363 smtp14.msoutlookonline.net 1234567 HX01234 F13EC56 102534897 True HE_CREATEACCOUNT eng 0 0 1 10 RESELLER1-STG rcom True True +03.00 0.766 true
Related commands HE_CancelAccount HE_ChangePassword HE_GetAccountDetails HE_GetAccounts HE_GetPricing HE_UpgradeAccount
3/13/09
317
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Account
Required
Hosted Microsoft Exchange account name. Permitted format is HXNNNNN
10
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
HostedExchangeID
Hosted Microsoft Exchange identification number, used by us to identify this account
AccountID
Hosted Microsoft Exchange account identification number, used by the Exchange servers to identify this account
LoginID
Account name of this Hosted Microsoft Exchange account, used by the customer to retrieve mail and manage this account
Password
Hosted Microsoft Exchange password
SignupDate
Date on which this Hosted Microsoft Exchange account was created
3/13/09
318
©2003-2009 Register.com, Inc.
Param name
API commands: HE_GetAccountDetails
Definition
TerminateDate
Date on which this Hosted Microsoft Exchange account is flagged for deletion
Terminate
Is this Hosted Microsoft Exchange flagged for deletion?
Status
Status of this Hosted Microsoft Exchange account. Possible values are: 1 Active 4 Disabled for nonpayment 5 Disabled for other reason
Plan
Hosted Microsoft Exchange plan represented by this account
Mailboxes
Number of mailboxes in this Hosted Microsoft Exchange account
BlackBerry
Number of BlackBerry devices currently subscribed in this Hosted Microsoft Exchange account
GoodLink
Number of Good Mobile Messaging devices currently subscribed in this Hosted Microsoft Exchange account
ActiveSync
Number of ActiveSync devices currently subscribed in this Hosted Microsoft Exchange account
ExtraStorage
Number of 100MB units of extra storage currently subscribed in this Hosted Microsoft Exchange account. Extra storage space is shared among all your mailboxes.
BillCycleID
Billing cycle identification number. 1 represents a one-month billing cycle
SMTPProxy
Primary domain name for this account.
NextBillingDate
Next billing date
NextBillingPeriod
Next billing period, in months
CurrentBillingPeriod
Current billing period, in months
BillingAmount
Amount that will be billed to your account on the next bill date
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query retrieves account details for one Hosted Microsoft Exchange account, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=HE_GetAccountDetails& uid=rcompartnerid&pw=rcompartnerpw&Account=HX57904&ResponseType=XML
In the response, the presence of account information and an ErrCount value 0 indicates that the query was successful: 24 1056747
3/13/09
319
©2003-2009 Register.com, Inc.
API commands: HE_GetAccountDetails
HX57904 3932293 1/8/2007 9:33:13 AM False 1 MSExchange_PLR (Gold) Copy 100 2 2 2 2 1 smtp14.msoutlookonline.net 2/8/2007 1 1 870 HE_GETACCOUNTDETAILS eng 0 0 10 RESELLER1-STG rcom +0.00 0.094 true
Related commands HE_CancelAccount HE_ChangePassword HE_CreateAccount HE_GetAccounts HE_GetPricing HE_UpgradeAccount
3/13/09
320
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
LoginID
Login ID for this Hosted Microsoft Exchange account
Password
Password for this Hosted Microsoft Exchange account
SignupDate
Date on which this Hosted Microsoft Exchange account was created
TerminateDate
If this Hosted Microsoft Exchange account has been tagged for cancellation, the date on which service will terminate
Terminate
Has this Hosted Microsoft Exchange account been tagged for cancellation?
Status
Status of this Hosted Microsoft Exchange account. Return values are: 1 Active 4 Disabled for nonpayment 5 Disabled for other reason
Plan
Hosted Microsoft Exchange plan represented by this account
3/13/09
321
©2003-2009 Register.com, Inc.
Param name
API commands: HE_GetAccounts
Definition
Mailboxes
Number of mailboxes in this Hosted Microsoft Exchange account
BlackBerry
Number of BlackBerry devices currently supported in this Hosted Microsoft Exchange account
GoodLink
Number of Good Mobile Messaging devices currently supported in this Hosted Microsoft Exchange account
ActiveSync
Number of ActiveSync devices currently supported in this Hosted Microsoft Exchange account
ExtraStorage
Number of 100MB units of extra storage currently subscribed in this Hosted Microsoft Exchange account. Extra storage space is shared among all your mailboxes.
BillCycleID
Billing cycle identification number. 1 represents a one-month billing cycle
SMTPProxy
Primary domain name for this account.
NextBillingDate
Next billing date
Count
Number of Hosted Microsoft Exchange accounts in this domain name account.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=HE_GETAccounts& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
In the response, a list of Hosted Microsoft Exchange accounts and an ErrCount value 0, indicate that the query was successful: HX60270 6DF9968 1/17/2007 5:55:39 PM False 1 MSExchange_PLR (Gold) Copy 1 1 1 1
3/13/09
322
©2003-2009 Register.com, Inc.
API commands: HE_GetAccounts
1 1 smtp14.msoutlookonline.net 2/17/2007 HX04967 C2EA47A 1/23/2007 5:26:26 PM False 1 MSExchange_PLR (Gold) Copy 1 2 3 4 1 1 smtp14.msoutlookonline.net 2/23/2007 . . . 8 HE_GETACCOUNTS eng 0 0 10 RESELLER1-STG rcom +0.00 0.172 true
Related commands HE_CancelAccount HE_ChangePassword HE_CreateAccount HE_GetAccountDetails HE_GetPricing HE_UpgradeAccount
3/13/09
323
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20 20
PW
Required
Account password
ShowAll
Optional; default is 1
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
GetQty
Required if ShowAll=0
Return the per-mailbox price for this number of mailboxes. Permitted values are 1 to 255
3
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
Qty
Number of Hosted Exchange mailboxes in this package
Price
Price per mailbox in this package
AdditionalStorage
Price for 100MB extra storage. When you purchase one unit of extra storage, 100MB is shared among all mailboxes.
BlackBerry
Monthly fee for BlackBerry support, per mailbox
3/13/09
324
©2003-2009 Register.com, Inc.
Param name
Definition
API commands: HE_GetPricing
GoodLink
Monthly fee for GoodLink support, per mailbox
ActiveSync
Monthly fee for ActiveSync support, per mailbox
BlackBerrySetup
One-time setup fee for BlackBerry support, per mailbox
GoodLinkSetup
One-time setup fee for GoodLink support, per mailbox
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=HE_GETPRICING& uid=rcompartnerid&pw=rcompartnerpw&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: 1 8.5 3 8 5 8 10 8 25 8 50 8
3/13/09
325
©2003-2009 Register.com, Inc.
API commands: HE_GetPricing
100 8 5 9 19 2 50 30 HE_GETPRICING eng 0 0 10 RESELLER1-STG rcom +0.00 0.344 true
Related commands HE_CancelAccount HE_ChangePassword HE_CreateAccount HE_GetAccountDetails HE_GetAccounts HE_UpgradeAccount
3/13/09
326
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Account
Required
Hosted Microsoft Exchange login ID. Permitted format is HXNNNNN
12
3/13/09
327
©2003-2009 Register.com, Inc.
Param name Obligation
API commands: HE_UpgradeAccount
Definition
Max size
ItemNameX X = 1 to maximum 5
At least one ItemNameX is Required
Permitted values are: Mailboxes ExtraStorage (1 unit of storage is 100MB, shared among all mailboxes in this Hosted Microsoft Exchange account) BlackBerry GoodLink ActiveSync
12
ItemLimitX X = 1 to maximum 5
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
3
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
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
Mailboxes
Final number of mailboxes in this Hosted Microsoft Exchange account, after the changes in this query string
BlackBerry
Final number of BlackBerry devices supported, after changes
GoodLink
Final number of Good Mobile Messenger devices supported, after changes
ActiveSync
Final number of ActiveSync devices supported, after changes
ExtraStorage
Final number of 100MB units of extra storage, after changes
OrderID
Order ID number for the upgrades in this query string
UpgradePrice
Amount, in $US, charged for this order, including one-time setup fees
NewPrice
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.
Success
True indicates that this query was successful
Upgrade
True indicates that the query string included upgrades, and that they were successful
Downgrade
True indicates that the query string included downgrades, and that they were successful
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
328
©2003-2009 Register.com, 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://partnertest.rcomexpress.com/interface.asp?command=HE_UPGRADEACCOUNT& uid=rcompartnerid&pw=rcompartnerpw&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: 0 true True HE_UPGRADEACCOUNT eng 0 0 10 RESELLER1-STG rcom +0.00 1.063 true
Related commands HE_CancelAccount HE_ChangePassword HE_CreateAccount HE_GetAccountDetails HE_GetAccounts HE_GetPricing
3/13/09
329
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
EndUserIP
Required
End user’s IP address. This is used in fraud checking, as part 15 of our order processing service. Use format NNN.NNN.NNN.NNN.
ItemCount
Optional
Number of items ready to purchase. All with a status of A (active)
4
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
330
©2003-2009 Register.com, Inc.
API commands: InsertNewOrder
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=insertneworder& uid=rcompartnerid&pw=rcompartnerpw&EndUserIP=127.0.0.1&responsetype=xml
The response confirms a successful checkout by sending an order ID number 156062745 10 INSERTNEWORDER 0 ResellerTest rcom true
3/13/09
331
©2003-2009 Register.com, Inc.
API commands: InsertNewOrder
Related commands AddBulkDomains AddToCart Check DeleteFromCart Extend Extend_RGP ExtendDomainDNS GetDomainExp GetExtendInfo GetRenew Purchase PurchasePreview SetRenew UpdateCart UpdateExpiredDomains
3/13/09
332
©2003-2009 Register.com, 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 registrar’s database. ModifyNSHosting, a similar command, redirects to another set of name servers without updating the Registry records.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
3/13/09
333
©2003-2009 Register.com, Inc.
API commands: ModifyNS
Param name Obligation Definition
Max size
UseDNS
Either UseDNS or NSX is Required
To switch to our name servers, supply UseDNS=Default
4
NSX X=1 to maximum of 12
Either UseDNS or NSX is Required
60 To switch to custom name servers or no name servers, supply the NSX parameter. Maximum of 12 name servers can be set. To designate custom name servers, supply the use name, for example, NS1=dns01.gpn.register.com To designate no name servers, supply an empty parameter: NS1=
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
•
To set name servers to Register.com’s 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 partnerdomain.com to dns01.gpn.register.com and dns02.gpn.register.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=modifyns& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com& ns1=dns01.gpn.register.com&ns2=dns02.gpn.register.com&responsetype=xml
The reponse confirms that the change of name servers was successful: False 1 200 Command completed successfully
3/13/09
334
©2003-2009 Register.com, Inc.
API commands: ModifyNS
MODIFYNS 0 ResellerTest rcom true
Related commands CheckNSStatus DeleteNameServer GetDNS GetDNSStatus ModifyNSHosting RegisterNameServer UpdateNameServer
3/13/09
335
©2003-2009 Register.com, 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 registrar’s database.
Availability All partners have access to this 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 name server cited in the query must exist.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
NSX X=1 to 12
Required
Name server—maximum of 12 can be set. Permitted value is 60 the use name of the name server, for example, NS1=dns01.gpn.register.com
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
3/13/09
336
©2003-2009 Register.com, Inc.
API commands: ModifyNSHosting
Param name
Definition
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query designates dns01.gpn.register.com as the name server for partnerdomain.com, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=modifynshosting& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com& ns1=dns01.gpn.register.com&responsetype=xml
The response is as follows: - False MODIFYNSHOSTING 0 ResellerTest rcom true -
Related commands CheckNSStatus DeleteNameServer GetDNS GetDNSStatus ModifyNS RegisterNameServer UpdateNameServer
3/13/09
337
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
EmailCount
Required
Number of accounts on this domain to update.
2
UserNameX X=1 to EmailCount
Required
POP3 user name to update the password on.
30
3/13/09
338
©2003-2009 Register.com, Inc.
API commands: ModifyPOP3
Param name Obligation Definition
Max size
IsAdminX X=1 to EmailCount
Either IsAdminX or PasswordX is Required. They may be used together.
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 else’s) 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)
PasswordX X=1 to EmailCount
New password for UserNameX’s mailbox. Either IsAdminX or PasswordX is Required. They may be used together.
50
ResponseType
Optional
4
Format of response. Options are Text (default), HTML, or XML.
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.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://partnertest.rcomexpress.com/interface.asp?command=modifypop3& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&emailcount=2& username1=john&password1=johnpw&username2=jane&password2=janepw&responsetype=xml
The response is as follows:
3/13/09
339
©2003-2009 Register.com, Inc.
API commands: ModifyPOP3
False MODIFYPOP3 0 ResellerTest rcom true
Related commands DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetForwarding GetMailHosts GetPOP3 PurchasePOPBundle SetUpPOP3User
3/13/09
340
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
SensitiveContent
Optional; default is False
Block potentially offensive content? Permitted values are True or False. True filters out offensive content.
5
MaxLength
Optional; default is 63
Maximum length of SLD to return. Permitted values are 2 numbers 2 to 63.
MaxResults
Optional; default is 20
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
UseHyphens
Optional; default is False
Return domain names that include hyphens? Permitted values are True or False.
5
UseNumbers
Optional; Return domain names that include numbers? Permitted default is True values are True or False.
5
3/13/09
341
©2003-2009 Register.com, Inc.
API commands: NameSpinner
Param name
Obligation
Definition
Max size
Basic
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.
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.
Similar
Optional; default is Medium
Higher values return suggestions that are similar to the 6 customer’s 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.
Topical
Optional; default is Medium
Higher values return suggestions that reflect current topics and popular words. Permitted values are Off, Low, Medium, and High.
ResponseType
Optional
Format of response. Options are Text (default), HTML, 4 or XML.
6
Returned parameters and values Param name Definition SpinCount
Number of SLDs returned in this response
TLDList
TLDs returned in this response
Domain name
SLD for this set of results
Com
Is this SLD available from the .com Registry? Y indicates yes; N indicates no.
ComScore
The Registry’s score of how closely this SLD matches the SLD input you supplied in the query string. Highest possible score is 1000.
Net
Is this SLD available from the .net Registry? Y indicates yes; N indicates no.
NetScore
The Registry’s score of how closely this SLD matches the SLD input you supplied in the query string. Highest possible score is 1000.
Tv
Is this SLD available from the .tv Registry? Y indicates yes; N indicates no.
TvScore
The Registry’s score of how closely this SLD matches the SLD input you supplied in the query string. Highest possible score is 1000.
Cc
Is this SLD available from the .cc Registry? Y indicates yes; N indicates no.
CcScore
The Registry’s score of how closely this SLD matches the SLD input you supplied in the query string. Highest possible score is 1000.
OriginalSLD
The SLD value you supplied in the input query string
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
342
©2003-2009 Register.com, Inc.
API commands: NameSpinner
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://partnertest.rcomexpress.com/interface.asp?command=NameSpinner& UID=rcompartnerid&PW=rcompartnerpw&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: 8 hand NAMESPINNER eng 0 0 1 10 RESELLER1-STG rcom True True +03.00 0.719 true
3/13/09
343
©2003-2009 Register.com, Inc.
API commands: NameSpinner
Related commands AddToCart Check Purchase
3/13/09
344
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
PassedDomain
Required
Full name to parse, including the third level if appropriate
70
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Host
Host name
SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain name (extension)
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
345
©2003-2009 Register.com, Inc.
API commands: ParseDomain
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.partnerdomain.com into its Host, SLD, and TLD, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=parsedomain& uid=rcompartnerid&pw=rcompartnerpw&passeddomain=www.partnerdomain.com& responsetype=xml
The response is as follows: www partnerdomain com PARSEDOMAIN 0 RESELLERTEST rcom True True true
Related commands None
3/13/09
346
©2003-2009 Register.com, 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 account’s 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
CPID
Pricing engine index, for use by Register.com’s database.
ProductType for domains
Product type. Permitted values are: 10 Domain registration 13 DNS hosting 14 DNS hosting renew 16 Domain renewal 17 Domain redemption grace period (RGP) 19 transfer 41 Registration and email forwarding by the .name Registry 44 .name registration and email forwarding renewal
3/13/09
347
©2003-2009 Register.com, Inc.
API commands: PE_GetCustomerPricing
Param name
Definition
ProductType for SSL certificates
Product type. Permitted values are: 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 180 SSL certificate - VeriSign Secure Site 181 SSL certificate - VeriSign Secure Site Pro 182 SSL certificate - VeriSign Secure Site EV 183 SSL certificate - VeriSign Secure Site Pro EV
ProductType for Web site creation services
Product type. Permitted values are: 86 Web Site Creator - Basic 87 Web Site Creator - Full 88 Web Site Creator - eCommerce
ProductType for email services
Product type. Permitted values are: 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 Registration and email forwarding by the .name Registry 42 Email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 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
ProductType for all other services
Product type. Permitted values are: 47 URL forwarding 48 URL forwarding - renewal 65 Private label annual subscription 66 Private label annual renewal 72 RCOM Shield (Whois Privacy Protection) 73 RCOM Shield - renewal
ProductDescription
Product description. Values are listed under ProductType, above.
TLDID
Top-level-domain ID number.
TLD
Top-level domain name.
RetailPrice
Retail price. Response contains a value only if price overrides the default value.
ResellerPrice
Reseller price.
Enabled
Enabled state for this TLD. Options are True or False.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
348
©2003-2009 Register.com, Inc.
API commands: PE_GetCustomerPricing
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 giambi charges for transferring a .org domain name, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=PE_GETCUSTOMERPRICING& uid=giambi&pw=giambipw&ProductType=19&tld=org&responsetype=xml
The response indicates that the price for transferring a .org name is $10.00, and .org transfers are enabled in this subaccount: 256759 19 Transfer 2 org 10.00 True PE_GETCUSTOMERPRICING 0 ResellerTest rcom true
Related commands CommissionAccount GetBalance PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_SetPricing
3/13/09
349
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
UseQtyEngine
Optional; default is 0
Return prices for multiple-year registrations? Permitted values are 0 and 1.
1
Years
Optional; default is 1
Number of years for multiple-year registrations. Permitted values are 1, 2, 5, and 10.
2
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
350
©2003-2009 Register.com, Inc.
API commands: PE_GetDomainPricing
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 rcompartnerid for the various top-level domains, with the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=PE_GETDOMAINPRICING& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response indicates that the price of .com domains is $10.00 per year, .net is $10.00 per year, and so on: com 10.00 True 10.00 True 10.00 True net 10.00 True 10.00 True 10.00 True org 10.00 True 10.00 True 10.00 True . . . PE_GETDOMAINPRICING 0 ResellerTest rcom true
3/13/09
351
©2003-2009 Register.com, Inc.
API commands: PE_GetDomainPricing
Related commands CommissionAccount GetBalance PE_GetCustomerPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_SetPricing
3/13/09
352
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Pop
Wholesale price this account pays per POP 10-pak
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
353
©2003-2009 Register.com, Inc.
API commands: PE_GetPOPPrice
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 rcompartnerid pays for a POP 10-pak, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=PE_GETPOPPRICE& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
In the response, a pop pricing value and an ErrCount value 0 confirm that the query was successful: 18.4015 PE_GETPOPPRICE en 0 0 10 RESELLERTEST rcom +0.00 8.203125E-02 true
Related commands GetPOP3 PE_GetCustomerPricing PE_GetDomainPricing PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing PE_SetPricing PurchasePOPBundle
3/13/09
354
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ProductType for domains (other ProductTypes follow)
A ProductType is 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) 19 transfer 41 Registration and email forwarding by the .name Registry 44 .name registration and email forwarding renewal
63
ProductType for SSL certificates (see adjacent rows for other ProductTypes)
Required
Product type. Permitted values are: 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 180 SSL certificate - VeriSign Secure Site 181 SSL certificate - VeriSign Secure Site Pro 182 SSL certificate - VeriSign Secure Site EV 183 SSL certificate - VeriSign Secure Site Pro EV
63
3/13/09
355
©2003-2009 Register.com, Inc.
API commands: PE_GetProductPrice
Param name Obligation
Definition
Max size
ProductType Required for Web site creation services (see adjacent rows for other ProductTypes)
Product type. Permitted values are: 86 Web Site Creator - Basic 87 Web Site Creator - Full 88 Web Site Creator - eCommerce
63
ProductType for email services (see adjacent rows for other ProductTypes)
Required
Product type. Permitted values are: 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 Registration and email forwarding by the .name Registry 42 Email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 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
63
ProductType for all other services (see previous rows for other ProductTypes)
Required
Product type. Permitted values are: 47 URL forwarding 48 URL forwarding - renewal 65 Private label annual subscription 66 Private label annual renewal 72 RCOM Shield (Whois Privacy Protection) 73 RCOM Shield - renewal
63
TLD
Required if ProductType is 10, 16, or 19
Top-level domain name (extension)
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.
20
ResponseType
Optional
4
Format of response. Options are Text (default), HTML, or XML.
Returned parameters and values Param name
Definition
Price
Wholesale price that the UID pays for this product
ProductEnabled
Enabled status of this product
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
356
©2003-2009 Register.com, Inc.
API commands: PE_GetProductPrice
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://partnertest.rcomexpress.com/interface.asp?command=PE_GETPRODUCTPRICE& uid=rcompartnerid&pw=rcompartnerpw&ProductType=10&tld=com&responsetype=xml
In the response, a price and an enabled status for the product confirm that the query was successful: 8.95 True PE_GETPRODUCTPRICE en 0 0 1 10 RESELLERTEST rcom True True +03.00 0.1015625 true
Related commands PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing PE_SetPricing
3/13/09
357
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ProductType for domains (other ProductTypes follow)
A ProductType is 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) 19 transfer 41 Registration and email forwarding by the .name Registry 44 .name registration and email forwarding renewal
63
3/13/09
358
©2003-2009 Register.com, Inc.
Param name Obligation ProductType for SSL certificates (see adjacent rows for other ProductTypes)
Required
ProductType Required for Web site creation services (see adjacent rows for other ProductTypes)
API commands: PE_GetResellerPrice
Definition
Max size
Product type. Permitted values are: 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 180 SSL certificate - VeriSign Secure Site 181 SSL certificate - VeriSign Secure Site Pro 182 SSL certificate - VeriSign Secure Site EV 183 SSL certificate - VeriSign Secure Site Pro EV
63
Product type. Permitted values are: 86 Web Site Creator - Basic 87 Web Site Creator - Full 88 Web Site Creator - eCommerce
63
ProductType for email services (see adjacent rows for other ProductTypes)
Required
Product type. Permitted values are: 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 Registration and email forwarding by the .name Registry 42 Email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 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
63
ProductType for all other services (see previous rows for other ProductTypes)
Required
Product type. Permitted values are: 47 URL forwarding 48 URL forwarding - renewal 65 Private label annual subscription 66 Private label annual renewal 72 RCOM Shield (Whois Privacy Protection) 73 RCOM Shield - renewal
63
TLD
Required for ProductType 10, 16, or 19
If the ProductType is 10, 16, or 19, specify the TLD for which you want pricing information.
20
Years
Optional; default is 1
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.
3
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
359
©2003-2009 Register.com, Inc.
API commands: PE_GetResellerPrice
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=PE_GETRESELLERPRICE& uid=rcompartnerid&pw=rcompartnerpw&tld=org&ProductType=10&responsetype=xml
The response indicates that a .org domain name is $10.00 per year: 10.00 True PE_GETRESELLERPRICE 0 ResellerTest rcom true
Related commands CommissionAccount GetBalance PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetRetailPrice PE_SetPricing
3/13/09
360
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Account login ID
20 20
Required
PW
Required
Account password
ProductType for domains (other ProductTypes follow)
A ProductTyp e is Required
Product type. Permitted values are: 63 10 Domain registration 13 DNS hosting 14 DNS hosting renew 16 Domain renewal 17 Domain redemption grace period (RGP) 19 transfer 41 Registration and email forwarding by the .name Registry 44 .name registration and email forwarding renewal
3/13/09
361
©2003-2009 Register.com, Inc.
API commands: PE_GetRetailPrice
Param name Obligation Definition ProductType for SSL certificates (see adjacent rows for other ProductTypes)
Required
ProductType Required for Web site creation services (see adjacent rows for other ProductTypes)
Max size
Product type. Permitted values are: 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 180 SSL certificate - VeriSign Secure Site 181 SSL certificate - VeriSign Secure Site Pro 182 SSL certificate - VeriSign Secure Site EV 183 SSL certificate - VeriSign Secure Site Pro EV
63
Product type. Permitted values are: 86 Web Site Creator - Basic 87 Web Site Creator - Full 88 Web Site Creator - eCommerce
63
ProductType for email services (see adjacent rows for other ProductTypes)
Required
63 Product type. Permitted values are: 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 Registration and email forwarding by the .name Registry 42 Email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 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
ProductType for all other services (see previous rows for other ProductTypes)
Required
Product type. Permitted values are: 47 URL forwarding 48 URL forwarding - renewal 65 Private label annual subscription 66 Private label annual renewal 72 RCOM Shield (Whois Privacy Protection) 73 RCOM Shield - renewal
63
TLD
Optional
If ProductType is 10, 16, or 19, include the TLD for which you want the retail price setting.
15
Years
Optional
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.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
3/13/09
4
362
©2003-2009 Register.com, Inc.
API commands: PE_GetRetailPrice
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=PE_GETRETAILPRICE& uid=rcompartnerid&pw=rcompartnerpw&ProductType=10&responsetype=xml
The response is as follows: 29.95 True PE_GETRETAILPRICE 0 ResellerTest rcom true
Related commands CommissionAccount GetBalance PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_SetPricing
3/13/09
363
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
TLDOnly
Optional; default is 0
Use TLDOnly=1 if you want only domain name prices; otherwise this command returns prices for domain names and all other products and services.
20
Years
Optional; default value is 1
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.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition TLD
3/13/09
Top-level domain name (extension)
364
©2003-2009 Register.com, Inc.
API commands: PE_GetRetailPricing
Param name Definition TLDID
Our ID number for this TLD
ProductType for domains
Product type. Permitted values are: 10 Domain registration 13 DNS hosting 14 DNS hosting renew 16 Domain renewal 17 Domain redemption grace period (RGP) 19 transfer 41 Registration and email forwarding by the .name Registry 44 .name registration and email forwarding renewal
ProductType for SSL certificates
Product type. Permitted values are: 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 180 SSL certificate - VeriSign Secure Site 181 SSL certificate - VeriSign Secure Site Pro 182 SSL certificate - VeriSign Secure Site EV 183 SSL certificate - VeriSign Secure Site Pro EV
ProductType Product type. Permitted values are: for Web site cre- 86 Web Site Creator - Basic ation services 87 Web Site Creator - Full 88 Web Site Creator - eCommerce ProductType for email services
Product type. Permitted values are: 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 Registration and email forwarding by the .name Registry 42 Email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 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
ProductType for all other services
Product type. Permitted values are: 47 URL forwarding 48 URL forwarding - renewal 65 Private label annual subscription 66 Private label annual renewal 72 RCOM Shield (Whois Privacy Protection) 73 RCOM Shield - renewal
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
365
©2003-2009 Register.com, Inc.
API commands: PE_GetRetailPricing
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 rcompartnerid is charging for all products, and whether the products are enabled. It also requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?uid=rcompartnerid&pw=rcompartnerpw& command=PE_GetRetailPricing&responsetype=xml
The response lists the prices for all products, and tells whether they are offered in this account: com 0 1 29.95 True 29.95 True 29.95 True net 1 1 29.95 True 29.95 True 29.95 True . . . 29.95 True 45 29.95 True 47 PE_GETRETAILPRICING 0 RESELLERTEST rcom 0
3/13/09
366
©2003-2009 Register.com, Inc.
API commands: PE_GetRetailPricing
0 true
Related commands PE_GetCustomerPricing PE_GetDomainPricing PE_GetResellerPrice PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_SetPricing UpdateAccountPricing
3/13/09
367
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition TLDID
ID number for the TLD specified in the query string.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
368
©2003-2009 Register.com, 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://partnertest.rcomexpress.com/interface.asp?command=PE_GETTLDID& uid=rcompartnerid&pw=rcompartnerpw&tld=org&responsetype=xml
In the response, a value for the TLDID parameter confirms that the query was successful: 2 PE_GETTLDID en 0 0 1 10 RESELLERTEST rcom True True +07.00 0.1015625 true
Related commands PE_SetPricing SetResellerTLDPricing
3/13/09
369
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
TLD
Required for ProductType 10, 13, 14, 16, 19
Top-level domain name (extension) to set pricing for
15
PartyID
If setting subaccount prices, either PartyID or LoginID is Required
Party ID of the subaccount to set pricing for
40
LoginID
If setting subaccount prices, either PartyID or LoginID is Required
Login ID of the subaccount to set pricing for
20
3/13/09
370
©2003-2009 Register.com, Inc.
API commands: PE_SetPricing
Param name Obligation
Definition
Years
Optional; default is 1
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.
ProductTypeX X=1, 2, 3, . . .
A ProductType is 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) 19 transfer 41 Registration and email forwarding by the .name Registry 44 .name registration and email forwarding renewal
63
Required
Product type. Permitted values are: 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 180 SSL certificate - VeriSign Secure Site 181 SSL certificate - VeriSign Secure Site Pro 182 SSL certificate - VeriSign Secure Site EV 183 SSL certificate - VeriSign Secure Site Pro EV
63
Required
Product type. Permitted values are: 86 Web Site Creator - Basic 87 Web Site Creator - Full 88 Web Site Creator - eCommerce
63
Required
Product type. Permitted values are: 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 Registration and email forwarding by the .name Registry 42 Email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 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
63
Domains in this row (other ProductTypes follow) ProductTypeX X=1, 2, 3, . . . SSL certificates in this row (see adjacent rows for other ProductTypes)
ProductTypeX X=1, 2, 3, . . . Web site creation services in this row
Max size
(see adjacent rows for other ProductTypes) ProductTypeX X=1, 2, 3, . . . Email services in this row (see adjacent rows for other ProductTypes)
3/13/09
371
©2003-2009 Register.com, Inc.
API commands: PE_SetPricing
Param name Obligation
Definition
Max size
ProductTypeX X=1, 2, 3, . . .
Required
Product type. Permitted values are: 47 URL forwarding 48 URL forwarding - renewal 65 Private label annual subscription 66 Private label annual renewal 72 RCOM Shield (Whois Privacy Protection) 73 RCOM Shield - renewal
63
EnabledX X=1, 2, 3, . . .
Optional
Enable or disable the product type. Set =1 to enable or =0 1 to disable.
PriceX X=1, 2, 3, . . .
Optional; use Set the product price. Use format DD.cc when setting retail prices for this UID
ResellerPrice
Optional; use when setting one wholesale price for one subaccount
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.
RetailPrice
Optional; use when setting one retail price for this UID
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.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
Miscellaneous services in this row (see previous rows for other ProductTypes)
1000. 00
1000. 00
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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.
3/13/09
372
©2003-2009 Register.com, 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://partnertest.rcomexpress.com/interface.asp?command=PE_SetPricing& uid=rcompartnerid&pw=rcompartnerpw&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: 2 Successful PE_SETPRICING 0 RESELLERTEST rcom True True true
Related commands AuthorizeTLD CommissionAccount GetBalance GetTLDList PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing SetResellerServicesPricing SetResellerTLDPricing UpdateAccountPricing
3/13/09
373
©2003-2009 Register.com, 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 partners have access to this command.
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.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Load
Required for .us, .ca, .co.uk, and .org.uk
1 use the previously configured values for all preconfiguration information 2 submit new preconfiguration information (contacts, name servers, extended attributes)
1
3/13/09
374
©2003-2009 Register.com, Inc.
API commands: Preconfigure
Param name
Obligation
Definition
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 and permitted values tagged as
AutoRenew
Required
Set to auto-renew? Permitted values are: 1 Set the preconfigured domains to renew automatically (recommended) 0 Set the domains to not auto-renew
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
IDNX X = 1 to NumberOfLanguages
Required for PUNYencoded names that use characters other than the English alphabet, numbers, and hyphen
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.
PreConfigDNS
Required
7 Which name servers this domain uses: default our name servers other name servers specified in this query using the NSX parameter
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.
UseHostRecords
Optional
1 Use host records provided in this query string. Permitted values are: 0 Use this account’s default host records 1 Store the host records provided in this string
HostNameX
Optional
Name of host record X, for example, www
3/13/09
Max size
1
3
63
60
375
©2003-2009 Register.com, Inc.
API commands: Preconfigure
Param name
Obligation
Definition
Max size
RecordTypeX
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
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
AccessPassword1
Optional
Domain name password
50
AccessPassword2
Optional
Domain name password. Must be identical to AccessPassword1.
50
ExpressCheckout
Either ExpressCheckout or all four OptX parameters are Required
1 If ExpressCheckout=1, the account’s default contacts will be applied. If ExpressCheckout=0 or is not used, supply contact information using the OptX and ContactTypeX parameters below.
3/13/09
376
©2003-2009 Register.com, Inc.
API commands: Preconfigure
Param name
Obligation
Definition
OptContactReg
Either ExpressCheckout or all four OptX parameters are Required
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
OptTechnical
Either ExpressCheckout or all four OptX parameters are Required
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
OptAdministrative
Either ExpressCheckout or all four OptX parameters are Required
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
OptContactAux
Either ExpressCheckout or all four OptX parameters are Required
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
ContactTypeOrg
Optional
Name of Contact’s organization. 60 ContactType can be REGISTRANT, AUXBILLING, TECH, ADMIN. Supply ContactType parameters for any contact type where you supplied OptX=UseExisting.
ContactTypeJobTitle
Optional
Contact’s job title
60
ContactTypeFName
Optional
Contact’s first name
60
ContactTypeLName
Optional
Contact’s last name
60
ContactTypeAddress
Optional
Contact’s address
60
ContactTypeAddress2
Optional
Contact’s address, second line
60
ContactTypeCity
Optional
Contact’s city
60
ContactTypeState
Optional
Contact’s state
60
3/13/09
Max size
377
©2003-2009 Register.com, Inc.
API commands: Preconfigure
Param name
Obligation
Definition
Max size
ContactTypeProvince
Optional
Contact’s province
60
ContactTypeStateProvinceChoice
Optional
Contact’s state or province choice. Use value S if Contact is located in a state; use P if a province.
1
ContactTypeZip
Optional for most TLDs; Required for .org
Contact’s postal code
16
ContactTypeCountry
Optional
Contact’s country. Permitted format 60 is 2-letter country code
ContactTypePhone
Optional
Contact’s phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
17
ContactTypePhoneExt
Optional
Contact’s phone extension
6
ContactTypeFax
Optional
Contact’s fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
17
ContactTypeEmail
Optional
Contact’s email address
128
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
PreConfigSuccess
1 indicates no extended attributes required. 2 indicates query failed at Registry.
Count
Number of TLDs affected
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
IsLockable
0 indicates the domain is not lockable; 1 indicates the domain is lockable
IsRealTimeTLD
Indicates whether this is a TLD that registers in real time. 0 indicates no; 1 indicates yes.
Done
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.
3/13/09
378
©2003-2009 Register.com, Inc.
API commands: Preconfigure
Example The following query supplies the extended attributes for partnerdomain.us and requests the response in XML format: http://partnertest.rcomexpress.com/ interface.asp?command=preconfigure&uid=rcompartnerid&pw=rcompartnerpw& sld=partnerdomain&tld=us&Load=2&us_nexus=c11&us_purpose=p3&PreConfigDNS=default& ExpressCheckout=1&responsetype=xml The response is as follows: Partner Domains Inc. President John Doe 111 Main St. Hometown NY S 99999 United States 5555555555 5555555556
[email protected] 2 . . . PRECONFIGURE 0 RESELLERTEST rcom False True true
Related commands AddContact Contacts GetContacts GetExtAttributes GetWhoisContact
3/13/09
379
©2003-2009 Register.com, 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.
Availability All partners have access to this 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 a reseller account directly under Register.com, 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.)
•
Register.com must be licensed to sell the names you attempt to register (Register.com 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.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
3/13/09
Max size
380
©2003-2009 Register.com, Inc.
API commands: Purchase
Param name
Obligation
Definition
ExtendedAttributes
Required for some country code TLDs
Data required by the Registry for some varies country codes. Use GetExtAttributes to determine whether this TLD requires extended attributes.
IDNCode
Optional for PUNY-encoded names that use characters other than the English alphabet, Arabic numbers, and hyphen
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.
UseDNS
Either UseDNS or NSX is Required
Specify UseDNS=default to use our name servers (most of the services that we provide require our name servers). See Note.
NSX
Either UseDNS or NSX is Required
60 Use this parameter to assign userspecified name servers. Permitted values are the use names of registered name servers, for example, NS1=dns01.gpn.register.com See Note.
UnLockRegistrar
Optional; default Set to 1 to unlock or 0 to lock the value is 0 name.
1
RenewName
Optional; default Set to 1 to renew the name value is 0 automatically before it expires.
1
DomainPassword
Optional; default Set a password on the domain name. value is 0
60
EmailNotify
Optional; default Set to 1 to receive email notification of 1 is 0 customer orders, set to 0 or don't use it otherwise.
NumYears
Optional
Number of years to register the name. 2
QueueOrder
Optional
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 records—they must be done after the order completes.
3/13/09
Max size
7
6
381
©2003-2009 Register.com, Inc.
API commands: Purchase
Param name
Obligation
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.
6
UseCreditCard
Optional
3
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
6
EndUserIP
Required if using End user’s 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.
15
CardType
Required if using Type of credit card our credit card processing
20
CCName
Required if using Cardholder's name our credit card processing
60
CreditCardNumber
Required if using Customer's credit card number our credit card processing
128
CreditCardExpMonth
Required if using Credit card expiration month our credit card processing
2
CreditCardExpYear
Required if using Credit card expiration year our credit card processing
4
CVV2
Required if using Credit card verification code our credit card processing
4
CCAddress
Required if using Credit card billing address our credit card processing
60
CCZip
Required if using Credit card billing postal code our credit card processing
15
CCCountry
Required if using Credit card billing country our credit card processing
60
3/13/09
Definition
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.
Max size
382
©2003-2009 Register.com, Inc.
API commands: Purchase
Param name
Obligation
RegistrantFirstName
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)
60
RegistrantLastName
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)
60
RegistrantOrganizationName
Optional
60
RegistrantJobTitle
Required if Registrant job title param RegistrantOrga nizationName is used
60
RegistrantAddress1
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)
60
RegistrantAddress2
Optional
60
3/13/09
Definition
Registrant organization
Registrant additional address info
Max size
383
©2003-2009 Register.com, Inc.
API commands: Purchase
Param name
Obligation
RegistrantCity
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)
60
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: S state P province
1
RegistrantStateProvince
Optional if using our credit card processing
Registrant state or province
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
16
RegistrantCountry
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)
60
RegistrantEmailAddress
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)
128
3/13/09
Definition
Max size
384
©2003-2009 Register.com, Inc.
API commands: Purchase
Param name
Obligation
Definition
Max size
RegistrantPhone
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)
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantFax
Required if RegistrantOrgani zationName is used
Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
ContactTypeFirstName
Optional
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.
60
ContactTypeLastName
Required if you ContactType last name supply one of the other core attributes for this ContactType (see Note)
ContactTypeOrganizationName
Optional
ContactTypeJobTitle
Required if you ContactType job title supply one of the other core attributes for this ContactType (see Note)
60
ContactTypeAddress1
ContactType address, line 1 Required if you supply one of the other core attributes for this ContactType (see Note)
60
ContactTypeAddress2
Optional
ContactTypeCity
ContactType city Required if you supply one of the other core attributes for this ContactType (see Note)
3/13/09
ContactType organization
60
ContactType additional address info
60
60 60
385
©2003-2009 Register.com, Inc.
Param name
API commands: Purchase
Obligation
Definition
Max size
ContactTypeStateProvinceChoice Optional
ContactType state or province choice: S state P province
1
ContactTypeStateProvince
Optional
ContactType state or province
60
ContactTypePostalCode
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)
ContactTypeEmailAddress
Required if you ContactType email address supply one of the other core attributes for this ContactType (see Note)
ContactTypePhone
Required if you supply one of the other core attributes for this ContactType (see Note)
ContactType phone. Required format is 20 +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
ContactTypeFax
Optional
ContactType fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
16
128
Returned parameters and values Param name Definition OrderID
Order number if successful. We recommend that you store this number for future use.
RRPCode
Success code. Only a 200 indicates success.
RRPText
Text which accompanies and describes the RRPCode value.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
386
©2003-2009 Register.com, Inc.
API commands: Purchase
Notes •
If using our credit card option ALL registrant and credit card information is required.
•
For most TLDs (those that don’t 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 Register.com’s, 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 value—at least the most recent one for each domain—from 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.
Example The following query requests the purchase of domain name partnerdomain2.net, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=Purchase& uid=rcompartnerid&pw=rcompartnerpw& sld=partnerdomain2&tld=net&RegistrantOrganizationName=Reseller%20Documents%20Inc.& RegistrantFirstName=john&RegistrantLastName=doe&RegistrantAddress1=111%20Main%20St.& RegistrantCity=Hometown&RegistrantStateProvince=NY&RegistrantStateProvinceChoice=S& RegistrantPostalCode=98003&RegistrantCountry=United+States& RegistrantEmailAddress=john%2Edoe%40partnerdomain%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: 156094996 200 Command completed successfully - 156094996 PURCHASE
3/13/09
387
©2003-2009 Register.com, Inc.
API commands: Purchase
0 Dev Workstation rcom true
Related commands AddBulkDomains Check InsertNewOrder PurchaseServices
3/13/09
388
©2003-2009 Register.com, 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 partners have access to this 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.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
DomainPassword
Optional
Set a password on the domain name
60
NumYears
Optional
Number of years to register the name
2
Renewname
Optional
Set =1 to auto-renew the name
1
ChargeAmount
Optional
Amount to charge per year for the registration
6
3/13/09
Max size
389
©2003-2009 Register.com, Inc.
API commands: PurchaseHosting
Param name
Obligation
Definition
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.
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
Required if UseCreditCard =yes
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
RegistrantOrganizationName
Optional
Registrant organization
60
RegistrantFirstName
Required if UseCreditCard =yes
Registrant first name
60
RegistrantLastName
Required if UseCreditCard =yes
Registrant last name
60
RegistrantJobTitle
Registrant job title Required if RegistrantOrga nizationName is used
60
RegistrantAddress1
Required if UseCreditCard =yes
60
Registrant Address
Max size
RegistrantAddress2
Optional
Registrant additional address info
60
RegistrantCity
Required if UseCreditCard =yes
Registrant city
60
RegistrantStateProvince
Required if UseCreditCard =yes
Registrant state or province
60
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: S state P province
1
RegistrantPostalCode
Required if UseCreditCard =yes
Registrant postal code
16
RegistrantCountry
Required if UseCreditCard =yes
Registrant country
60
RegistrantPhone
Required if UseCreditCard =yes
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
3/13/09
390
©2003-2009 Register.com, Inc.
API commands: PurchaseHosting
Param name
Obligation
Definition
Max size
RegistrantFax
Required if RegistrantOrga nizationName is used
Registrant fax numbe. Required format 20 is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
RegistrantEmailAddress
Required if UseCreditCard =yes
Registrant email address
128
CardType
Required if UseCreditCard =yes
Type of credit card
20
CCName
Required if UseCreditCard =yes
Cardholder's name
60
CreditCardNumber
Required if UseCreditCard =yes
Customer's credit card number
128
CreditCardExpMonth
Required if UseCreditCard =yes
Credit card expiration month
2
CreditCardExpYear
Required if UseCreditCard =yes
Credit card expiration year
4
CVV2
Required if UseCreditCard =yes
Credit card verification code
4
CCAddress
Required if UseCreditCard =yes
Credit card billing address
60
CCZip
Required if UseCreditCard =yes
Credit card billing postal code
15
CCCountry
Required if UseCreditCard =yes
Credit card billing country
60
EmailNotify
Optional
Set =1 to receive email notification for 1 orders, set =0 or omit this parameter otherwise.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition OrderID
Order number if successful.
RRPCode
Success code. Only a 200 indicates success.
RRPText
Text which accompanies and describes the RRPCode.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
391
©2003-2009 Register.com, Inc.
API commands: PurchaseHosting
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=purchasehosting& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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: 156062635 PURCHASEHOSTING 0 ResellerTest rcom true
Related commands ExtendDomainDNS DeleteHostedDomain GetHosts SetHosts
3/13/09
392
©2003-2009 Register.com, 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 sender’s address), and for parties who want to manage multiple email accounts as a body (rather than having everyone’s email forwarded to scattered locations). After you sell a POP Email bundle, you can set up users with the SetUpPOP3User command.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
20
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
Quantity
Required
Number of 10-address paks.
10
ResponseType
Optional in all Format of response. Options are Text (default), cases HTML, or XML.
3/13/09
4
393
©2003-2009 Register.com, Inc.
API commands: PurchasePOPBundle
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
OrderID
Identification number of the order
BundleID
Identification number of each POP3 10-pak
BundleCount
Number of POP 10-paks sold in this transaction, if more than one
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=PurchasePOPBundle& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&Quantity=1&responsetype=xml
In the response, the return of an orderid value and a bundleid value confirm a successful query: False 156133590 5134 PURCHASEPOPBUNDLE 0 ResellerTest rcom true
3/13/09
394
©2003-2009 Register.com, Inc.
API commands: PurchasePOPBundle
Related commands DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetDotNameForwarding GetForwarding GetMailHosts GetPOP3 GetPOPExpirations GetPOPForwarding ModifyPOP3 PurchaseHosting PurchaseServices RenewPOPBundle SetDotNameForwarding SetPOPForwarding SetUpPOP3User
3/13/09
395
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition ItemID
Shopping cart item ID, from our internal records
Description
Description of shopping cart item
Years
Number of time units customer wants to subscribe
NameID
Domain name ID, from our internal records
Name
Name the customer has requested for this item
StatusID
Status ID
ItemPrice
Price for one unit of this item
ExtPrice
ItemPrice multiplied by Years (number of time units)
NeedsConfig
Flag that marks domains requiring pre-configuration
ProductType
Product type ID number, from our internal records
3/13/09
396
©2003-2009 Register.com, Inc.
API commands: PurchasePreview
Param name Definition FreeTrial
Is this product being offered as a free trial?
ParentItemID
Parent item ID number, from our internal records
ICANNFees
Fees charged by ICANN for this product
BasePrice
Price of this product before the ICANN fee
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid and an inventory of its shopping cart, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=purchasepreview& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response gives some general information about the account, plus the current contents of the shopping cart: True 3627.65 3587.85 1 10.00 10.00 10.00 24.95 39.95 365635 Register 2 152534050 partnerdomain.com A 10.00 20.00 20.00 PURCHASEPREVIEW 0
3/13/09
397
©2003-2009 Register.com, Inc.
API commands: PurchasePreview
Dev Workstation rcom true
Related commands AddBulkDomains AddToCart DeleteFromCart GetCartContent InsertNewOrder UpdateCart
3/13/09
398
©2003-2009 Register.com, Inc.
API commands: PurchaseServices
PurchaseServices Description Definition Purchase, in real time, RCOM Shield, SSL certificates, POP Email, Web Site Creator, 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 RCOM Shield and DNS hosting.
Availability All partners have access to this command.
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, RCOM Shield is not available for .us.
•
To use our credit card processing (available only for RCOM Shield and DNS hosting in the PurchaseServices suite of products), this must be a GPN 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 RCOM Shield Input parameters for SSL Certificates Input parameters for POP Email Input parameters for Web Site Creator Input parameters for DNS hosting
Input parameters for RCOM Shield The table below lists input parameters for RCOM Shield.
3/13/09
399
©2003-2009 Register.com, Inc.
API commands: PurchaseServices
Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Service
Required
Permitted value for RCOM Shield is WPPS
15
SLD
Required for WPPS Second-level domain name (for example, register in register.com).
63
TLD
Required for WPPS Top-level domain name (extension).
15
NumYears
Optional for Number of years to subscribe to WPPS; default is 1 RCOM Shield
2
RenewName
Optional for Use RenewName=1 to automatically 1 WPPS; default is 0 renew RCOM Shield 30 days before it expires
EmailNotify
Optional; default is 0
Permitted values are 0 and 1. 1 sends 3 you an email confirmation when a customer makes a purchase using this command.
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.
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
Required for our credit card processing
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
ChargeAmount
Required for our CC Amount to charge for each year; 6 processing ChargeAmount will be multiplied by NumYears. Required format is DD.cc
CardType
Required for our CC Credit card type. Permitted values are 20 processing Visa, Mastercard, AmEx, Discover
CreditCardNumber
Required for our CC Credit card number processing
CreditCardExpMonth
Required for our CC Expiration month of the credit card, in 2 processing format MM
CreditCardExpYear
Required for our CC Expiration year of the credit card, in processing format YYYY
4
CVV2
Required for our CC Credit card verification value processing, if printed on the card
4
3/13/09
15
128
400
©2003-2009 Register.com, Inc.
API commands: PurchaseServices
Param name
Obligation
Definition
Max size
CCName
Required for our CC Cardholder’s name processing
60
CCAddress
Required for our CC Credit card billing street address processing
60
CCZip
Required for our CC Credit card billing postal code processing
60
CCPhone
Optional for our CC Credit card billing phone. Required processing format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
20
RegistrantFirstName
Required for our CC Registrant first name processing
60
RegistrantLastName
Required for our CC Registrant last name processing
60
RegistrantAddress1
Required for our CC First line of Registrant address processing
60
RegistrantAddress2
Optional for our CC Second line of Registrant address processing
60
RegistrantCity
Required for our CC Registrant city processing
60
RegistrantStateProvince
Optional for our CC Registrant state or province, if processing applicable
60
RegistrantStateProvinceChoice
Optional for our CC Is the RegistrantStateProvince 60 processing value a state or a province? Permitted values are S for state, P for province.
RegistrantPostalCode
Required for our CC Registrant postal code processing
RegistrantCountry
Required for our CC Registrant country. Two-letter country 60 processing code is a permitted format.
RegistrantPhone
Required for our CC Registrant phone. Required format is processing +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantPhoneExt
Optional for our CC Registrant phone extension processing
60
RegistrantFax
Optional for our CC Registrant fax. Required format is processing +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
60
RegistrantEmailAddress
Required for our CC Registrant email address processing
128
ResponseType
Optional in all cases
16
Format of response. Options are Text 4 (default), HTML, or XML.
Input parameters for SSL Certificates The table below lists input parameters for SSL certificates.
3/13/09
401
©2003-2009 Register.com, Inc.
API commands: PurchaseServices
Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Service
Required
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-VeriSign-Secure-Site Certificate-VeriSign-Secure-Site-Pro Certificate-VeriSign-Secure-Site-EV Certificate-VeriSign-Secure-Site-Pro-EV
15
NumYears
Optional for certs; default is 1
Number of years to purchase this cert. Permitted values are 1 to the following maxima: 5 GeoTrust QuickSSL 6 GeoTrust QuickSSL Premium 5 GeoTrust True BusinessID 5 GeoTrust True BusinessID Wildcard 2 GeoTrust True BusinessID with EV 5 RapidSSL 5 VeriSign Secure Site 5 VeriSign Secure Site Pro 2 VeriSign Secure Site with EV 2 VeriSign Secure Site Pro with EV
2
ResponseType
Optional in all cases Format of response. Options are Text (default), HTML, or XML.
4
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
UID
Required
Account login ID
20
PW
Required
Account password
20
Service
Required
Type of service to purchase. For POP Email, Service=POP3.
15
SLD
Required for POP3
Second-level domain name (for example, register in register.com).
63
TLD
Required for POP3
Top-level domain name (extension).
15
3/13/09
Definition
Max size
402
©2003-2009 Register.com, Inc.
Param name
API commands: PurchaseServices
Obligation
Definition
Max size
Quantity
Required for POP3
For POP3, number of 10-address POP paks.
10
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.
ResponseType
Optional in all cases Format of response. Options are Text (default), HTML, or XML.
4
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Service
Required
Type of service to purchase. For WSC, use Service=LWSCBasic, LWSCFull, or LWSCECom.
15
SLD
Required for LWSCBasic, LWSCFull, and LWSCECom
Second-level domain name (for example, register in register.com). For LWSC*, this is the domain WSC will be associated with.
63
TLD
Required for LWSCBasic, LWSCFull, and LWSCECom
Top-level domain name (extension). For LWSC*, this is the domain WSC will be associated with.
15
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.
ResponseType
Optional in all cases Format of response. Options are Text (default), HTML, or XML.
4
Input parameters for DNS hosting The table below lists input parameters for DNS hosting.
3/13/09
403
©2003-2009 Register.com, Inc.
API commands: PurchaseServices
Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20 20
PW
Required
Account password
Service
Required
Type of service to purchase. For DNS hosting, 15 use Service=DNSHosting.
NumYears
Required for DNSHosting
Number of years to subscribe to this service. Permitted values are 1 to 10.
2
SLD
Required for DNSHosting
Second-level domain name (for example, register in register.com).
63
TLD
Required for DNSHosting
Top-level domain name (extension).
15
DomainPassword
Optional for DNSHosting
Set a password on the domain name
60
RenewName
Optional for DNSHosting
Set to 1 to auto-renew the name
1
RegistrantLastName
Required for DNSHosting
Registrant last name
60
RegistrantAddress1
Required for DNSHosting
First line of Registrant address
60
RegistrantPostalCode
Required for DNSHosting
Registrant postal code
16
RegistrantEmailAddress Required for DNSHosting
Registrant email address
128
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.
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. Credit card processing is available for DNSHosting.
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.
3
EndUserIP
Required for our credit card processing
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
ChargeAmount
Required for our CC processing
6 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
3/13/09
404
©2003-2009 Register.com, Inc.
API commands: PurchaseServices
Param name
Obligation
Definition
Max size
CardType
Required for our CC processing
Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover
20
CreditCardNumber
Required for our CC processing
Credit card number
128
CreditCardExpMonth
Required for our CC processing
Expiration month of the credit card, in format 2 MM
CreditCardExpYear
Required for our CC processing
Expiration year of the credit card, in format YYYY
4
CVV2
Required for our CC processing, if printed on the card
Credit card verification value
4
CCName
Required for our CC processing
Cardholder’s name
60
CCAddress
Required for our CC processing
Credit card billing street address
60
CCZip
Required for our CC processing
Credit card billing postal code
60
CCPhone
Optional for our CC processing
Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
20
RegistrantFirstName
Required for our CC processing
Registrant first name
60
RegistrantAddress2
Optional for our CC processing
Second line of Registrant address
60
RegistrantCity
Required for our CC processing
Registrant city
60
RegistrantCountry
Required for our CC processing
Registrant country. Two-letter country code is 60 a permitted format.
RegistrantPhone
Required for our CC processing
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
ResponseType
Optional in all cases Format of response. Options are Text (default), HTML, or XML.
20
4
Returned parameters and values Param name
Definition
CCTransResult
Credit card preauthorization result; included when using our credit card processing for Service=WPPS or DNSHosting
BundleID
Our identification number for this POP pak; included for Service=POP3
BundleCount
Total number of POP paks purchased with this query; included for Service=POP3
OrderID
Order ID number
CertID
Cert ID for the cert purchased in this order; included for any cert purchase
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
405
©2003-2009 Register.com, Inc.
API commands: PurchaseServices
Param name
Definition
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query adds three POP mail paks to domain partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=PURCHASESERVICES& uid=rcompartnerid&pw=rcompartnerpw&Service=POP3&sld=partnerdomain&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: 156272481 8069 8070 8071 3 PURCHASESERVICES eng 0 0 1 10 RESELLERTEST rcom True True +03.00 0.5429688 true
3/13/09
406
©2003-2009 Register.com, Inc.
API commands: PurchaseServices
Related commands Forwarding GetHomeDomainList Purchase PurchaseHosting PurchasePOPBundle RenewServices SetHosts
3/13/09
407
©2003-2009 Register.com, 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 Register.com account to another.
Availability All partners have access to this 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 Register.com or one of its resellers.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
AccountID
Required
Login ID of the account to push the name into. Use GetSubAccounts to list subaccounts.
16
PushContact
Optional; default is 1
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
16
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
408
©2003-2009 Register.com, Inc.
API commands: PushDomain
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
PushDomain
Returns =1 if successful or =0 if it fails
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain2.net be pushed from account rcompartnerid to account giambi, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=pushdomain& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain2&tld=net&accountid=giambi&responsetype=xml
The response is as follows: False partnerdomain2.net 1 PUSHDOMAIN 0 Dev Workstation rcom true
3/13/09
409
©2003-2009 Register.com, 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
3/13/09
410
©2003-2009 Register.com, 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 partners have access to this command.
Constraints The query must meet the following requirements: •
The login ID and password must be valid.
•
The account must be a reseller account.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
UID
Required
Account login ID
20
PW
Required
Account password
20
Debit
Required
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.
EndUserIP
Required to add funds to this account
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
3/13/09
Max size
15
411
©2003-2009 Register.com, Inc.
API commands: RefillAccount
Param name
Obligation
Definition
Max size
CCAmount
Required to add funds to this account
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.
CCType
Required to add funds to this account
Credit card type. Options are AmEx, Discover, 10 MasterCard, Visa.
CCName
Required to add funds to this account
Credit card holder’s name as imprinted on the credit card
60
CCNumber
Required to add funds to this account
16-digit credit card number
16
CCMonth
Required to add funds to this account
Month in which credit card expires, in MM format
2
CCYear
Required to add funds to this account
Year in which credit card expires, in YYYY format
4
CVV2
Required to add funds to this account
Credit card security verification code, 3- or 4digit number from the back of the credit card
4
CCAddress
Required to add funds to this account
Street address as shown on credit card bill
60
CCCity
Optional
City as shown on credit card bill
60
CCStateProvince Required to add funds to this account
State or province as shown on credit card bill
60
CCZip
Required to add funds to this account
Zip code or postal code as shown on credit card 16 bill
CCCountry
Required to add funds to this account
Country of credit card billing address, expressed as 2-character country code
2
CCPhone
Required to add funds to this account
Phone number as shown on credit card bill. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
SendMail
Optional
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.
2
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
Reseller
1 indicates that this is a reseller account
CCTRANSRESULT
Result of the credit card transaction
ResellerRefill
Success status of the account refill
CreditCardStatus
Success status of the credit card transaction
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
412
©2003-2009 Register.com, Inc.
API commands: RefillAccount
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 rcompartnerid, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=REFILLACCOUNT& uid=rcompartnerid&pw=rcompartnerpw&CCAmount=100&CCType=MasterCard& CCName=JohnDoe&CCNumber=5215521552155215&CCMonth=02&CCYear=2009& cvv2=200&ccaddress=100+Main+St.&CCStateProvince=NY&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: Wednesday, August 20, 2007 John Doe 1 APPROVED Transactions processed successfully. Successful 2004 2 ************5215 JohnDoe MasterCard 100 Main St. Hometown NY us 5555559999 99999 REFILLACCOUNT 0 RESELLERTEST rcom 0 0 true
3/13/09
413
©2003-2009 Register.com, Inc.
API commands: RefillAccount
Related commands GetBalance GetTransHistory UpdateNotificationAmount
3/13/09
414
©2003-2009 Register.com, 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 partners have access to this 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.
•
Register.com 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Account login ID
20 20
Required
PW
Required
Account password
Add
Required
Authority to add a name server. Set Add=true to authorize. 5
NSName
Required
Name server to register. Use format dns1.NameServerName.com
60
IP
Required
IP of the name server.
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
415
©2003-2009 Register.com, Inc.
API commands: RegisterNameServer
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 dns01.gpn.register.com, be registered as a name server. The query requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=registernameserver& uid=rcompartnerid&pw=rcompartnerpw&add=true&nsname=dns1.partnerdomain.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: dns1.partnerdomain.com 127.0.0.1 1 ACTIVE 1 REGISTRAR-LOCK 200 Command completed successfully REGISTERNAMESERVER 0 TestServer rcom true
3/13/09
416
©2003-2009 Register.com, Inc.
API commands: RegisterNameServer
Related commands CheckNSStatus DeleteNameServer GetDNS GetDNSStatus ModifyNS ModifyNSHosting UpdateNameServer
3/13/09
417
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
TLD
Either TLD or DomainList is Required
One top-level domain (TLD) to remove from your list of authorized TLDs. For example, if you want to remove .biz, use TLD=biz
15
DomainList
Either TLD or DomainList is Required
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
100
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
418
©2003-2009 Register.com, Inc.
API commands: RemoveTLD
Returned parameters and values Param name Definition DeleteTLDX
List of TLDs to remove from the list of TLDs authorized for this account. Indexed X when ResponseType=Text or HTML.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid‘s list of authorized TLDs, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=removetld& uid=rcompartnerid&pw=rcompartnerpw&domainlist=us,ca&responsetype=xml
In the response, the list of TLDs and the ErrCount value of 0 confirm that the query was successful: us ca REMOVETLD en 0 0 10 RESELLERTEST rcom 1.191406 true
3/13/09
419
©2003-2009 Register.com, Inc.
API commands: RemoveTLD
Related commands AuthorizeTLD GetTLDList PE_SetPricing SetResellerTLDPricing
3/13/09
420
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
UID
Required
Account login ID. Must be a reseller account.
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
PakID
Required
ID number of this POP pak. You can retrieve the ID numbers of all POP paks in the account with the GetPOPExpirations command.
10
Quantity
Required
Number of years to renew this POP pak subscription
2
3/13/09
Max size
421
©2003-2009 Register.com, Inc.
API commands: RenewPOPBundle
Param name
Obligation
Definition
UseCreditCard
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
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
Required for our credit card processing
15 End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
RegistrantFirstName
Required for our CC processing
Registrant first name
60
RegistrantLastName
Required for our CC processing
Registrant last name
60
RegistrantAddress1
Required for our CC processing
First line of Registrant address
60
RegistrantAddress2
Optional for our CC processing
Second line of Registrant address
60
RegistrantCity
Required for our CC processing
Registrant city
60
RegistrantCountry
Required for our CC processing
Registrant country. Two-letter country code is a permitted format.
60
RegistrantPostalCode
Required for our CC processing
Registrant postal code
16
RegistrantPhone
Required for our CC processing
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantEmailAddress Required for our CC processing
Registrant email address
128
CardType
Required for our CC processing
Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover
20
CCName
Required for our CC processing
Cardholder’s name
60
CreditCardNumber
Required for our CC processing
Credit card number
128
3/13/09
Max size
422
©2003-2009 Register.com, Inc.
API commands: RenewPOPBundle
Param name
Obligation
Definition
Max size
CreditCardExpMonth
Required for our CC processing
Expiration month of the credit card, in format MM 2
CreditCardExpYear
Required for our CC processing
Expiration year of the credit card, in format YYYY 4
CVV2
Required for our CC processing
Credit card verification code
4
CCAddress
Required for our CC processing
Credit card billing address
60
ChargeAmount
Required for our CC processing
Amount to charge this credit card. Required format is DD.cc
6
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition OrderID
Order ID for a successful renewal
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=renewpopbundle& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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: E False 156227365 RENEWPOPBUNDLE
3/13/09
423
©2003-2009 Register.com, Inc.
API commands: RenewPOPBundle
en 0 0 1 10 RESELLERTEST rcom True True 0.34375 true
Related commands Extend GetPOP3 GetPOPExpirations GetRenew Purchase PurchasePOPBundle RenewServices
3/13/09
424
©2003-2009 Register.com, 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 RCOM Shield.
Availability All partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
UID
Required
Account login ID
20
PW
Required
Account password
20
Service
Required
Service to be renewed. Permitted value for RCOM Shield is RCOMShield
15
NumYears
Optional; default is 1
Number of years to renew this service
2
SLD
Required for RCOMShield
Second-level domain name (for example, register in register.com) for the domain this service is associated with
63
TLD
Required for RCOMShield
Top-level domain name (extension) for the domain this service is associated with
15
3/13/09
Definition
Max size
425
©2003-2009 Register.com, Inc.
API commands: RenewServices
Param name
Obligation
Definition
Max size
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 RCOMShield.
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.
3
EndUserIP
Required for our credit card processing
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
ChargeAmount
Required for our CC processing
Amount to charge for each year; ChargeAmount is multiplied by NumYears. Required format is DD.cc
6
CardType
Required for our CC processing
Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover
20
CreditCardNumber
Required for our CC processing
Credit card number
128
CreditCardExpMonth
Required for our CC processing
Expiration month of the credit card, in format MM
2
CreditCardExpYear
Required for our CC processing
Expiration year of the credit card, in format YYYY
4
CVV2
Required for our CC processing, if printed on the card
Credit card verification value
4
CCName
Required for our CC processing
Cardholder’s name
60
CCAddress
Required for our CC processing
Credit card billing street address
60
CCZip
Required for our CC processing
Credit card billing postal code
60
3/13/09
426
©2003-2009 Register.com, Inc.
API commands: RenewServices
Param name
Obligation
Definition
Max size
CCPhone
Optional for our CC processing
Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
20
RegistrantFirstName
Required for our CC processing
Registrant first name
60
RegistrantLastName
Required for our CC processing
Registrant last name
60
RegistrantAddress1
Required for our CC processing
First line of Registrant address
60
RegistrantAddress2
Optional for our CC processing
Second line of Registrant address
60
RegistrantCity
Required for our CC processing
Registrant city
60
RegistrantStateProvince
Optional for our CC processing
Registrant state or province, if applicable 16
RegistrantStateProvinceChoice
Optional for our CC processing
Is the RegistrantStateProvince value a state or a province? Permitted values are S for state, P for province.
16
RegistrantPostalCode
Required for our CC processing
Registrant postal code
16
RegistrantCountry
Required for our CC processing
Registrant country. Two-letter country code is a permitted format.
60
RegistrantPhone
Required for our CC processing
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantPhoneExt
Optional for our CC processing
Registrant phone extension
16
RegistrantFax
Optional for our CC processing
Registrant fax. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters
128
RegistrantEmailAddress
Required for our CC processing
Registrant email address
128
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
427
©2003-2009 Register.com, Inc.
API commands: RenewServices
Returned parameters and values Param name Definition OrderID
Identification number for tracking this order in our system
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query renews RCOM Shield for two years and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=renewservices& uid=rcompartnerid&pw=rcompartnerpw&sld=rcompartnerid&tld=rcompartnerpw& service=RCOMShield&numyears=2&responsetype=xml
In the response, an order ID number confirms that the query was successful: 157405437 RENEWSERVICES eng 0 0 1 10 RESELLER1-STG rcom True True +08.00 0.797 true
Related commands PurchaseServices RenewPOPBundle
3/13/09
428
©2003-2009 Register.com, 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 partners have access to this 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.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Version
Optional; default is 0
Version of this command. Permitted values are 0 and 20 1. Use Version=1 to receive the return parameters listed in the Returned parameters table below. Version=0 and Version=1 return parameters vary slightly in the data returned and in the tag names. We recommend that you use Version=1, which avoids timeouts by supporting paging of results, and queueing of the query.
3/13/09
429
©2003-2009 Register.com, Inc.
API commands: RPT_GetReport
Param name
Obligation
Definition
Max size
ReportType
Required
Type 0 1 2 11 3 4 5 6 10
1
BeginDate
Optional; default is the last day of the month, two months before the current month
First date to include in the report. Must be no earlier than six months before today. Use format MM/DD/YYYY
10
EndDate
Optional; default is today’s date
Last date to include in the report. Use format MM/DD/YYYY
10
Start
Optional; default is 1
In the overall list of returns for this report type and date range, the start position for the return to this query.
8
RecordsToReturn
Number of items to return in this report. Optional; default is 100 if Download= False default is 9999 if Download= True
Download
Required
Do you wish to run report in real time or deliver to this account’s Billing contact email address? Permitted values are True to send the report via email, False to run in real time and deliver via the API return. Reports will always be delivered by email if they extend past four months before today, or if they include more than 25,000 results.
ReportOutputType
Required
If delivering the report via email, ReportOutputType must be 2.
ResponseType
Required
Format of response. Permitted value is XML.
of report to generate. Permitted values are: Registrations Renewals Transfers in Transfers out Private label Subaccounts Accounting Expiring names Pricing Editor updates
8
4
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
RptString
List report descriptions
ThreeMoPast
The date three months before today
SixMoPast
The date six months before today
3/13/09
430
©2003-2009 Register.com, Inc.
API commands: RPT_GetReport
Param name
Definition
BeginDate
The first date included in this report
EndDate
The last date included in this report
ID
Report type identification number
Name
Report name
ReportType
Report type specified in this query string
ReportName
Name of the report type specified in this query string
QueueReportResults
Should report results be queued? Permitted values are 1 to queue results; 0 to send results immediately via HTTP.
ReportResults
Results specific to this report type. The results, and return parameters, vary by report type.
NewStartPosition
In the full list of results, the start position of the next page of results
ThisStartPosition
In the full list of results, the position of the first result listed on this page
ThisEndPosition
In the full list of results, the position of the last result listed on this page
PreviousStartPosition
In the full list of results, the position of the previous page of results
TotalReturned
Number of results listed on this page
TotalRows
Number of results total for this report
ShowPrevious
Should this page show a link to the previous page of results?
ShowNext
Should this page show a link to the next page of results?
ShowPaging
Should this page show links to previous and next results?
Version
Version of this command that generated this return
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 12/1/2009 to 1/1/2010, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=RPT_GETREPORT& uid=rcompartnerid&pw=rcompartnerpw&ReportType=0& BeginDate=12/01/2009&EndDate=01/01/2010&responsetype=xml
The response is as follows: Registrations | Renewals | Transfers In | Private Label | Sub-Accounts | Accounting | Expiring Domains | | | | Pricing Editor Updates | Transfers Out | | 10/01/2009
3/13/09
431
©2003-2009 Register.com, Inc.
API commands: RPT_GetReport
07/01/2009 12/01/2009 01/01/2010 0 Registrations 0 375 1.072000 52 1 51 51 375 0 True True 1 RPT_GETREPORT en 0 0
3/13/09
432
©2003-2009 Register.com, Inc.
API commands: RPT_GetReport
1 10 RESELLERTEST rcom True True 0.8125 true
Related commands CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccounts GetTransHistory
3/13/09
433
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
LoginID
Required
Login ID of subaccount
20
Account
Required
ID number of subaccount, in NNN-aa-NNNN format. Use the GetSubAccounts command to retrieve the subaccount ID number.
11
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
434
©2003-2009 Register.com, Inc.
API commands: SendAccountEmail
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://partnertest.rcomexpress.com/interface.asp?command=SendAccountEmail& uid=rcompartnerid&pw=rcompartnerpw&loginID=rcompartneridsub&account=659-fs-2869 &responsetype=xml
In the response, an ErrCount value 0 confirms that the query was successful: SENDACCOUNTEMAIL eng 0 0 10 RESELLERTEST rcom +0.00 0.078125 true
Related commands GetAccountPassword GetAccountValidation GetSubAccounts
3/13/09
435
©2003-2009 Register.com, 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, RCOM Shield 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 partners have access to this 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.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
Service
Required; if Service type. Permitted values are: Service is EmailSet (email services) used without WPPS (RCOM Shield Whois Privacy Protection) NewOptionID and Update, the response gives the current setting
3/13/09
20 15
436
©2003-2009 Register.com, Inc.
Param name Obligation
API commands: ServiceSelect
Definition
Max size
NewOptionID
4 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) 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 server’s IP address required) 1114 POP3/WebMail plus email forwarding Service=WPPS (RCOM Shield Whois Privacy Protection): 1120 WhoIs information is masked 1123 WhoIs information is viewable
Update
Required if you True updates the NewOptionID value for the service use NewOptionID
SLD
Required for Service= EmailSet WPPS
Second-level domain name (for example, register in register.com)
63
TLD
Required for Service= EmailSet WPPS
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
5
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
current-svc
Current service option setting
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
3/13/09
437
©2003-2009 Register.com, Inc.
API commands: ServiceSelect
Example The following query enables email services, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=serviceselect& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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): False partnerdomain.com True 1114 SERVICESELECT 0 ResellerTest rcom true
Related commands ModifyNS PE_SetPricing SetHosts SetResellerServicesPricing
3/13/09
438
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size 20
UID
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ForwardTo
Required
Email address to forward mail to. Use format
[email protected]
130
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition CatchAll
Email address that mail will be sent to if the addressee mailbox does not exist
Command
Name of command executed
3/13/09
439
©2003-2009 Register.com, Inc.
API commands: SetCatchAll
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=SetCatchAll& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&
[email protected]&responsetype=xml
In the response, the presence of the CatchAll email address you supplied confirms that the query was successful:
[email protected] SETCATCHALL eng 0 0 10 RESELLERTEST rcom +0.00 0.09375 true
3/13/09
440
©2003-2009 Register.com, Inc.
API commands: SetCatchAll
Related commands DeletePOP3 Forwarding GetCatchAll GetDotNameForwarding GetForwarding GetPOP3 GetPOPForwarding SetDotNameForwarding SetPOPForwarding SetUpPOP3User
3/13/09
441
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size 20
UID
Required
Account login ID
PW
Required
Account password
20
ObjectID
Required
Object ID number, an integer assigned by you.
2
Type
Required
Object type. Options are: 1 Data pertaining to an account 2 Data pertaining to a domain 3 Data pertaining to an order
1
SLD
Required if Type=2
Second-level domain name (for example, register in register.com)
63
TLD
Required if Type=2
Top-level domain name (extension)
15
OrderID
Required if Type=3
Order ID, which you can retrieve using GetDomainStatus.
11
Key
Required
Title of this entry, or label describing this data field
50
Value
Required
Content of this entry
50
3/13/09
442
©2003-2009 Register.com, Inc.
API commands: SetCustomerDefinedData
Param name Obligation
Definition
Max size
DisplayFlag
Recommended
Visibility to subaccount. Options are: 0 Not visible when logged on with subaccount ID 1 Visible when logged on using subaccount ID
1
EnteredBy
Recommended
Name of the person adding this entry
50
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=SetCustomerDefinedData& uid=rcompartnerid&pw=rcompartnerpw&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: SETCUSTOMERDEFINEDDATA 0 RESELLERTEST rcom True True true
3/13/09
443
©2003-2009 Register.com, Inc.
API commands: SetCustomerDefinedData
Related commands DeleteCustomerDefinedData GetCustomerDefinedData
3/13/09
444
©2003-2009 Register.com, 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.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Zone
Required
The host and domain name that you want to update in the DNS. For example, www.partnerdomain.com.
93
DomainPassword
Required
Password for managing the domain (a domain that uses the SetDNSHost command must have a password)
60
Address
Optional
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.
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
445
©2003-2009 Register.com, Inc.
API commands: SetDNSHost
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.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://partnertest.rcomexpress.com/interface.asp?command=SetDNSHost& zone=partnerdomain.com&DomainPassword=tester&responsetype=xml
The error count value 0 confirms that the DNS host was set successfully: E False SETDNSHOST 0 Reseller5 rcom True True true
Related commands GetHosts GetRegHosts SetHosts
3/13/09
446
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63 15
TLD
Required
Top-level domain name (extension)
HostIDX
Optional
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.
ServiceX
Required
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
14
ProtocolX
Required
Transport protocol for this record, such as TCP or UDP
14
3/13/09
447
©2003-2009 Register.com, Inc.
API commands: SetDomainSRVHosts
Param name Obligation
Definition
Max size
PriorityX
Required
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
5
WeightX
Required
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
5
PortX
Required
Port to use for this service. Permitted format is numbers from 0 to 65535
5
TargetX
Required
Fully qualified domain name for this SRV record. Permitted format is SRVRecordName.SLD.TLD. (include the trailing period in a fully qualified domain name)
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition InsertedCount
Number of SRV records added
UpdatedCount
Number of SRV records edited
DeletedCount
Number of SRV records deleted
Success
Success status of this query
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query keeps an existing SRV record and adds a new record, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=SETDOMAINSRVHOSTS& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&HostID1=17217418& Service1=imap&Protocol1=TCP&Priority1=10&Weight1=50&Port1=1& Target1=imap.partnerdomain.com.&HostID2=&Service2=xmpp&Protocol2=UDP& Priority2=10&Weight2=50&Port2=98&Target2=xmpp.partnerdomain.com.& ResponseType=XML
3/13/09
448
©2003-2009 Register.com, Inc.
API commands: SetDomainSRVHosts
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: 1 0 0 true SETDOMAINSRVHOSTS eng 0 0 1 10 RESELLERTEST rcom True True +03.00 0.078 true
Related commands GetDomainInfo GetDomainSRVHosts GetHosts SetHosts
3/13/09
449
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=SetDomainSubServices&uid=yourloginid &pw=yourpassword&sld=domain&tld=com&ActivateForwarding=0&ActivateHostRecords=1
Param name
Obligation Definition
Max size
UID
Required
20
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ActivateForwarding
Optional; default is 1
Enable email forwarding? Permitted values are: 1 to enable 0 to disable
1
ActivateHostRecords
Optional; default is 1
Enable URL forwarding? Permitted values are: 1 to enable 0 to disable
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
450
©2003-2009 Register.com, Inc.
API commands: SetDomainSubServices
Returned parameters and values Param name
Definition
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
EmailForwarding
1, 0 or empty
HostRecords
1, 0 or empty
SetDomainServices
Successful or Failed
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=setdomainsubservices& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain2&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: E False 1 1 Successful SETDOMAINSUBSERVICES 0 RESELLERTEST rcom True True true
3/13/09
451
©2003-2009 Register.com, Inc.
API commands: SetDomainSubServices
Related commands GetDomainSubServices
3/13/09
452
©2003-2009 Register.com, 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 Registry’s email forwarding feature (you can also use Register.com’s email forwarding with .name domains).
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID PW
Required
Account login ID
20
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ForwardTo
Required
Email address to forward to, in the format
[email protected]
120
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition ForwardTo
Email address to which email will be forwarded
Command
Name of command executed
3/13/09
453
©2003-2009 Register.com, Inc.
API commands: SetDotNameForwarding
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=setdotnameforwarding& uid=rcompartnerid&pw=rcompartnerpw&sld=john.doe&tld=name&
[email protected]&responsetype=xml
The response is as follows: E False
[email protected] SETDOTNAMEFORWARDING 0 Reseller3 rcom False True true
Related commands Forwarding GetCatchAll GetDotNameForwarding GetForwarding PurchasePOPBundle SetUpPOP3User
3/13/09
454
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63 15
TLD
Required
Top-level domain name (extension)
HostNameX X=1 to maximum 50
Required
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.
3/13/09
455
©2003-2009 Register.com, Inc.
API commands: SetHosts
Param name Obligation Definition
Max size 5
RecordTypeX X=1 to maximum 50
Required
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
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)
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
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
456
©2003-2009 Register.com, Inc.
API commands: SetHosts
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 partnerdomain.com. The results: •
partnerdomain.com forwards mail to IP address 66.150.5.189.
•
photos.partnerdomain.com points to domain name photos.msn.com
•
yahoo.partnerdomain.com points to IP address 204.71.200.72 msn.partnerdomain.com points to URL http://www.msn.com
•
http://partnertest.rcomexpress.com/interface.asp?command=sethosts& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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: E False SETHOSTS 0 Dev Workstation rcom True True true
Related commands GetHosts GetMetaTag GetRegHosts GetSPFHosts PurchaseServices SetDomainSRVHosts SetDNSHost SetSPFHosts UpdateMetaTag
3/13/09
457
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
BundleID
Required
Numerical ID for the POP pak (retrieve the bundle ID using the GetPOP3 command)
4
AutoPakRenew
Required
Auto-renew setting to be applied to this POP pak. Permitted values are 1 (on) or 0 (off)
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition DomainRRP
Domain type
RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
3/13/09
458
©2003-2009 Register.com, Inc.
API commands: SetPakRenew
Param name Definition PakUpdated
Bundle ID of the POP pak for which the auto-renew value is being reset
AutoPakRenew Auto-renew setting for the pak. Values are 1 (on) or 0 (off) Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=SETPAKRENEW& uid=rcompartnerid&pw=rcompartnerpw&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: E False 5105 1 SETPAKRENEW 0 RESELLERTEST rcom True True true
Related commands GetPOP3 GetRenew SetRenew UpdateCusPreferences
3/13/09
459
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63 15
TLD
Required
Top-level domain name (extension)
DomainPassword
Required
Password to access and manage the domain name. Must 60 use ASCII characters and be 6 to 60 characters in length.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
460
©2003-2009 Register.com, Inc.
API commands: SetPassword
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com as partnerdomainpw, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=setpassword& uid=rcompartnerid&pw=rcompartnerpw& sld=partnerdomain&tld=com&domainpassword=partnerdomainpw&responsetype=xml
The response confirms that the password is set successfully: False SETPASSWORD 0 Dev Workstation rcom true
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetRegLock SetRenew StatusDomain ValidatePassword
3/13/09
461
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
UserName
Required
The user name for this mailbox (email address will be
[email protected]).
30
EMail
Required
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]).
ForwardTo
Required
Email address to forward to. Use format
[email protected]
3/13/09
130
462
©2003-2009 Register.com, Inc.
API commands: SetPOPForwarding
Param name Obligation
Definition
Max size
Enable
Required
Add this email forwarding? Permitted values are: 0 Delete this email forwarding address 1 Add or change this email forwarding address
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
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Success
1 indicates the query was successful
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=SETPOPFORWARDING& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com& username=sales&Email=partnerdomain.com&forwardTo=info@partnerdomain.com& Enable=1&StatusFlags=1&ResponseType=xml
In the response, the Success value 1 indicates that the query was successful: E False 1 SETPOPFORWARDING en 0 0 1 10 RESELLERTEST
3/13/09
463
©2003-2009 Register.com, Inc.
API commands: SetPOPForwarding
rcom True True +03.00 0.1328125 true
Related commands DeletePOP3 GetCatchAll GetPOP3 GetPOPForwarding PurchasePOPBundle SetUpPOP3User
3/13/09
464
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
UnlockRegistrar
Required
Lock option to be set. Permitted values are 1 to unlock, 0 to lock).
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
RegistrarLock
Current lock status if successful, (=Failed otherwise).
Command
Name of command executed
3/13/09
465
©2003-2009 Register.com, Inc.
API commands: SetRegLock
Param name Definition ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/Interface.asp?command=setreglock& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&unlockregistrar=0& responsetype=xml
The response is as follows: False REGISTRAR-LOCK 200 Command completed successfully SETREGLOCK 0 Dev Workstation rcom true
3/13/09
466
©2003-2009 Register.com, Inc.
API commands: SetRegLock
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRenew StatusDomain ValidatePassword
3/13/09
467
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
RenewFlag
Required
Turn the auto-renew setting for the domain on or off. Options are 1 to auto-renew, 0 otherwise
1
AutoPakRenew
Optional
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.
EmailForwardRenew
Optional
Turn the auto-renew setting for email forwarding in 1 this domain on or off. Permitted values are 1 to autorenew, 0 otherwise.
3/13/09
468
©2003-2009 Register.com, Inc.
API commands: SetRenew
Param name
Obligation Definition
Max size
URLForwardRenew
Optional
Turn the URL forwarding setting for POP paks in this domain on or off. Permitted values are 1 to autorenew, 0 otherwise.
1
WPPSRenew
Optional
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.
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
RenewName
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
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query requests that partnerdomain.com renew automatically, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=setrenew& uid=rcompartnerid&pw=rcompartnerpw& sld=partnerdomain&tld=com&renewflag=1&responsetype=xml
The response confirms that the autorenew flag is set successfully (RenewName=1): False 1 SETRENEW 0 Dev Workstation rcom true
3/13/09
469
©2003-2009 Register.com, Inc.
API commands: SetRenew
Related commands Extend GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword InsertNewOrder SetPakRenew SetPassword SetRegLock StatusDomain UpdateExpiredDomains ValidatePassword
3/13/09
470
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
Account password
PW
Required
SubUID
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
DotNameBundle
Optional
Price you are charging this subaccount for a name-andemail .name bundle, in DD.cc format
5
DNSHosting
Optional
Price you are charging this subaccount for one year of DNS hosting, in DD.cc format
5
3/13/09
20 20
471
©2003-2009 Register.com, Inc.
API commands: SetResellerServicesPricing
Param name
Obligation
Definition
Max size
POP3
Optional
Price you are charging this subaccount for a POP3 10-pak, in DD.cc format
5
WPPS
Optional
5 Price your are charging this subaccount for a one-year subscription to Whois Privacy Protection Service, in DD.cc format
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition ServiceX
Name of this service. Indexed X when ResponseType=Text or HTML.
PriceX
Price you set for this service. Indexed X when ResponseType=Text or HTML.
ServicesCount
Number of services listed in this response (all services, not just those for which you set prices in your query)
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query sets prices for services—wholesale prices that rcompartnerid charges subaccount 443-up-6579—and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=SETRESELLERSERVICESPRICING uid=rcompartnerid&pw=rcompartnerpw&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: 2 SETRESELLERSERVICESPRICING en 0 0
3/13/09
472
©2003-2009 Register.com, Inc.
API commands: SetResellerServicesPricing
1 10 ResellerTest rcom 0 0 0.6875 true
Related commands GetSubAccounts PE_SetPricing SetResellerTLDPricing
3/13/09
473
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
Account password
PW
Required
SubUID
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
TLDPrice
Optional
Price you are charging this subaccount for registering this 5 TLD, in DD.cc format
TLDRenew
Optional
Price you are charging this subaccount for renewing this TLD, in DD.cc format
5
TLDTransfer
Optional
Price you are charging this subaccount for transferring this TLD, in DD.cc format
5
DotNameBundle
Optional
Price you are charging this subaccount for a name-andemail .name bundle, in DD.cc format
5
3/13/09
20 20
474
©2003-2009 Register.com, Inc.
API commands: SetResellerTLDPricing
Param name
Obligation
Definition
Max size
POP3
Required
Price you are charging this subaccount for a POP3 10pak, in DD.cc format
5
WPPS
Required
Price you are charging this subaccount for WhoIs Privacy Protection Service, in DD.cc format
5
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
price tld="TLD" id="ID" prod="Prod"
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.
tldX
TLD. Indexed X when ResponseType=Text or HTML.
tldIDX
TLD ID number from our database. Indexed X when ResponseType=Text or HTML.
productIDX
Product ID number from our database. Indexed X when ResponseType=Text or HTML.
priceX
Product price. Indexed X when ResponseType=Text or HTML.
DotNameBundle
The price of a one-year subscription to a .name name-andemail bundle
NameX
Name of product. Indexed X when ResponseType=Text or HTML.
PriceX
The price for a one-year subscription to product. Indexed X when ResponseType=Text or HTML.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query sets prices for some TLDs and services in account rcompartnerid, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=SETRESELLERTLDPRICING& uid=rcompartnerid&pw=rcompartnerpw&account=443-up-6579& comprice=12.95&comrenew=12.95&comtransfer=12.95&
3/13/09
475
©2003-2009 Register.com, Inc.
API commands: SetResellerTLDPricing
netprice=12.95&netrenew=12.95&nettransfer=12.95& orgprice=8.95&orgrenew=8.95&orgtransfer=8.95& 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: 12.95 12.95 12.95 12.95 12.95 12.95 12.95 12.95 12.95 15 3 SETRESELLERTLDPRICING en 0 0 1 10 RESELLERTEST False True 1.492188 true
Related commands AuthorizeTLD GetSubAccountDetails GetSubAccounts GetTLDList PE_GetTLDID PE_SetPricing RemoveTLD SetResellerServicesPricing
3/13/09
476
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
HostID
Required when updating an SPF host record
Host ID number from our database. You can retrieve this value using the GetSPFHosts command.
10
HostName
Required
Host name, assigned by you
63
RecordType
Required
For SPF records, the required value is txt
5
3/13/09
477
©2003-2009 Register.com, Inc.
API commands: SetSPFHosts
Param name Obligation
Definition
Max size
Address
Required
The SPF record. For help writing this record, you can go to http://spf.pobox.com/wizard.html
255
MXPref
Optional
Host record preference for setting the SPF record. The lower the number, the higher the priority. If not specified, default value is 10.
5
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=SETSPFHOSTS& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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: E False SETSPFHOSTS en 0 0 1 10 RESELLERTEST rcom True True
3/13/09
478
©2003-2009 Register.com, Inc.
API commands: SetSPFHosts
+03.00 0.2382813 true
Related commands GetHosts GetSPFHosts SetHosts
3/13/09
479
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
BundleID
Required
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.
integer
POPUserName
Required
The user name to set up (email address will be
[email protected]).
30
3/13/09
480
©2003-2009 Register.com, Inc.
API commands: SetUpPOP3User
Param name Obligation Definition
Max size
IsAdmin
1
Optional
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 else’s) 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)
POPPassword
Required
POP3 password.
50
POPFullName
Optional
User's full name, appears in Web mail.
60
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=SetupPop3user& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&BundleID=5134&POPUserName=james& POPPassword=rcompartnerpw&POPFullName=James+Doe&responsetype=xml
In the response, the value 0 for parameter ErrCount indicates that the query was successful: False SETUPPOP3USER 0 ResellerTest
3/13/09
481
©2003-2009 Register.com, Inc.
API commands: SetUpPOP3User
rcom true
Related commands DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetCatchAll GetDotNameForwarding GetForwarding GetMailHosts GetPOP3 GetPOPForwarding ModifyPOP3 PurchasePOPBundle SetDotNameForwarding SetUpPOP3User
3/13/09
482
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
OrderType
Optional
Options are Purchase(default), Transfer or Extend.
10
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition DomainName
Name being statused
Registrar
Returns Known, Unknown, or None.
3/13/09
483
©2003-2009 Register.com, Inc.
API commands: StatusDomain
Param name Definition InAccount
Returns 0 if not in an Register.com account, 1 if in your Register.com account or 2 if in another Register.com account.
OrderID
ID number of the most recent order that included this domain.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=statusdomain& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&responsetype=xml
The response is as follows: partnerdomain.com Known 1 6/25/2012 4:20:24 PM 156062089 200 Command completed successfully STATUSDOMAIN 0 Dev Workstation rcom true
3/13/09
484
©2003-2009 Register.com, Inc.
API commands: StatusDomain
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetDomainStatus GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew ValidatePassword
3/13/09
485
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Account
Required
Subaccount ID number, in NNN-aa-NNNN format. Use the GetSubAccounts command to retrieve this code.
11
Tab
Required
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
9
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
Tab
Category of names returned
MultiRRP
Do names in this account include credentials of more than one registrar?
Domain-List Type
Description of the category of names returned
3/13/09
486
©2003-2009 Register.com, Inc.
Param name
API commands: SubAccountDomains
Definition
DomainNameID
Domain name ID number, from our records
SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain name (extension)
NS-Status
YES indicates that this domain uses our default name servers
Expiration-Date
Expiration date of this domain registration
Auto-Renew
Is this domain set to renew automatically?
EndPosition
Position in the overall list of the last domain returned with this query
PreviousRecords
Number of domains in the overall list before the first domain in this list
NextRecords
Number of domains in the overall list after the last domain in this list
OrderBy
Sorting parameter for names
Result
Did this query yield any names?
StartPosition
Position in the overall list of the first domain returned with this query
DomainCount
Total number of domains in this subaccount
TotalDomainCount
Total number of domains in this parent account
StartLetter
First letter of the domains returned with this query
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=SUBACCOUNTDOMAINS& uid=rcompartnerid&pw=rcompartnerpw&Account=493-yp-5836&tab=iown&responsetype=xml
The response is as follows: iown False 152556719 subpartnerdomain com NA 8/2/2006 Yes
3/13/09
487
©2003-2009 Register.com, Inc.
API commands: SubAccountDomains
152556721 subpartnerdomain2 net NA 8/2/2006 Yes 152556722 subpartnerdomain3 info NA 8/2/2006 Yes 3 0 0 True 1 3 225 SUBACCOUNTDOMAINS en 0 0 1 10 RESELLERTEST e True True +03.00 0.2109375 true
Related commands CreateAccount CreateSubAccount GetSubAccountDetails GetSubAccountPassword GetSubAccounts GetSubaccountsDetailList
3/13/09
488
©2003-2009 Register.com, Inc.
API commands: SynchAuthInfo
SynchAuthInfo Description Definition Synchronize a domain’s 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
EmailEPP
Required
Should we mail the EPP key to the registrant of this domain name? Permitted values are True and False
5
RunSynchAutoInfo
Required
Should we synchronize the EPP key for this domain and make sure our records are identical to the Registry’s? Permitted values are True and False.
5
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
489
©2003-2009 Register.com, Inc.
API commands: SynchAuthInfo
Returned parameters and values Param name
Definition
InfoSynched
Returns True if EPP key has been synchronized at Registry. This parameter displays when EmailEPP=False
EPPEmailMessage
Returns confirmation that EPP key is emailed to registrant. This parameter displays when EmailEPP=True
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=SynchAuthInfo& UID=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&tld=com&EmailEPP=True& RunSynchAutoInfo=True&ResponseType=xml
The response is as follows: Email has been sent. SYNCHAUTHINFO eng 0 0 1 10 RESELLER1-STG rcom True True +03.00 1.715 true
Related commands TP_CreateOrder
3/13/09
490
©2003-2009 Register.com, Inc.
API commands: TP_CancelOrder
TP_CancelOrder Description Definition Cancel a transfer order that has been submitted by Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
20
PW
Required
Account login ID Account password
20
TransferOrderID Required
Transfer order ID number. To retrieve this value, use the TP_GetOrderStatuses command.
10
ResponseType
Format of response. Options are Text (default), HTML, or XML.
4
Optional
Returned parameters and values Param name Definition Success
Returns True if transfer request was successfully cancelled
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
491
©2003-2009 Register.com, Inc.
API commands: TP_CancelOrder
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 order’s 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://partnertest.rcomexpress.com/interface.asp?command=TP_CancelOrder& uid=rcompartnerid&pw=rcompartnerpw&transferOrderID=445413&responsetype=xml
In the response, the return value True for the Success parameter confirms the successful cancellation of the order: True TP_CANCELORDER 0 Dev Workstation rcom true
3/13/09
492
©2003-2009 Register.com, 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
3/13/09
493
©2003-2009 Register.com, 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 Register.com 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
DomainCount
Required
The number of domain names to be 4 submitted on the order. This number must match the actual number of names submitted.
OrderType
Required
Permitted values are Fax or Autoverification
20
SLDX X=1 to DomainCount
Required
Second-level domain name (for example, register in register.com)
63 15
TLDX
Required
Top-level domain name (extension)
AuthInfoX
Required for EPP TLDs
Current (“losing”) registrar’s authorization 20 key
3/13/09
494
©2003-2009 Register.com, Inc.
API commands: TP_CreateOrder
Param name
Obligation Definition
UseContacts
Optional
Set =1 to transfer existing WhoIs contacts 1 when the transfer is complete
ExtendedAttributes
Required for TLDs that use extended attributes, when UseContacts =0
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
Optional for resellers who use our credit card processing AND want to charge this transaction to the credit card included in this query string
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
Required for our CC processing
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
RegistrantAddress1
Optional; Required for Fax orders and for our CC processing
Registrant address
60
RegistrantAddress2
Optional
Registrant additional address info
60
RegistrantCity
Optional; Required for Fax orders and for our CC processing
Registrant city
60
RegistrantCountry
Optional; Required for Fax orders and for our CC processing
Registrant country
60
RegistrantEmailAddress
Optional; Required for Fax orders
Registrant email address
128
RegistrantFax
Optional
Registrant fax number. Required format is 20 +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
3/13/09
Max size
495
©2003-2009 Register.com, Inc.
API commands: TP_CreateOrder
Param name
Obligation Definition
Max size
RegistrantFirstName
Optional; Required for Fax orders and for our CC processing
Registrant first name
60
RegistrantLastName
Optional; Required for Fax orders and for our CC processing
Registrant last name
60
RegistrantJobTitle
Optional
Registrant job title
60
RegistrantOrganizationName
Optional; Required for Fax orders
Registrant organization
60
RegistrantPhone
Optional; Required for Fax orders and for our CC processing
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantPostalCode
Required for our CC processing and for .org names when you supply new Registrant information
Registrant postal code
16
RegistrantStateProvince
Required for our CC processing
Registrant state or province
60
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: S state P province
1
CardType
Required for our CC processing
Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover
20
CCName
Required for our CC processing
Cardholder’s name
60
CreditCardNumber
Required for our CC processing
Credit card number
128
CreditCardExpMonth
Required for our CC processing
Expiration month of the credit card, in format MM
2
CreditCardExpYear
Required for our CC processing
Expiration year of the credit card, in format YYYY
4
3/13/09
496
©2003-2009 Register.com, Inc.
API commands: TP_CreateOrder
Param name
Obligation Definition
Max size
CVV2
Required for our CC processing
Credit card verification code
4
CCAddress
Required for our CC processing
Credit card billing address
60
ChargeAmount
Required for our CC processing
Amount to charge this credit card. Required format is DD.cc
6
PreConfig
Optional
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.
1
DomainPassword
Optional
Set a domain access password on the domain name
16
Lock
Optional
Set =1 to turn on RegistrarLock option
1
Renew
Optional
Set =1 to turn on Auto-Renew option
1
AuthString
Optional
Authorization string for automated transfer order entries (approved accounts only)
100
ResponseType
Optional in all Format of response. Options are Text cases (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
TransferOrderID Transfer order number. Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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.
•
Additional params for contact information can be passed by replacing Registrant in the param names above with Tech, Admin or AuxBilling.
3/13/09
497
©2003-2009 Register.com, Inc.
API commands: TP_CreateOrder
•
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 partnerdomain2.net and partnerdomain3.info, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=TP_CreateOrder& uid=rcompartnerid&pw=rcompartnerpw&orderType=AutoVerification& sld1=partnerdomain2&tld1=net&AuthInfo1=ros8enQi& sld2=partnerdomain3&tld2=info&AuthInfo2=pkv7ihRb& domaincount=2&responsetype=xml
The response confirms the successful creation of transfer order 445413, and gives details of the transfer: 445413 7/29/2002 5:19:29 PM 1 Auto Verification 4 Processing 20.00 1 301770 partnerdomain2 net 9 Awaiting auto verification of transfer request 10.00 0 301771 partnerdomain3 info 9 Awaiting auto verification of transfer request 10.00 0 2 True TP_CREATEORDER 0 Dev Workstation rcom true
3/13/09
498
©2003-2009 Register.com, Inc.
API commands: TP_CreateOrder
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
3/13/09
499
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition OrderCount
Number of transfer orders that have been submitted for this domain.
OrderIDX X=1 to OrderCount
Transfer order detail number. Indexed X when ResponseType=Text or HTML.
OrderDateX
The date the order was submitted. Indexed X when ResponseType=Text or HTML.
3/13/09
500
©2003-2009 Register.com, Inc.
API commands: TP_GetDetailsByDomain
Param name Definition StatusIDX
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.
StatusDescX
TransferOrderDetail status description—a text description of the status of this domain in the transfer process. See Notes. Indexed X when ResponseType=Text or HTML.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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.
Example The following query requests transfer information for partnerdomain2.net, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=TP_GetDetailsByDomain& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain2&tld=net&responsetype=xml
3/13/09
501
©2003-2009 Register.com, Inc.
API commands: TP_GetDetailsByDomain
The response confirms that partnerdomain2.net is part of transfer order ID 445413, and gives current status of that order: 445413 3/29/2003 5:19:29 PM 9 Awaiting auto verification of transfer request 1 TP_GETDETAILSBYDOMAIN 0 Dev Workstation rcom true
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
3/13/09
502
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
TransferOrderID Required
Transfer order ID number. You can retrieve this number by calling the TP_GetOrderStatuses command.
10
ResponseType
Format of response. Options are Text (default), HTML, or XML.
4
Optional
Returned parameters and values Param name
Definition
TransferOrderID
Transfer order number
OrderDate
Date the order was entered
OrderTypeID
Type ID of order
OrderTypeDesc
Type of order
StatusID
Status ID of order. See Notes.
StatusDesc
Status description of order. See Notes.
3/13/09
503
©2003-2009 Register.com, Inc.
API commands: TP_GetOrder
Param name
Definition
AuthAmount
Charge amount for this order
TransferOrderDetailID Transfer order detail number SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain name (extension)
Price
Cost of the name transfer
UseContacts
Use original contacts or not
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 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
3/13/09
504
©2003-2009 Register.com, Inc.
API commands: TP_GetOrder
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://partnertest.rcomexpress.com/interface.asp?command=TP_GetOrder& uid=rcompartnerid&pw=rcompartnerpw&TransferOrderID=445413&responsetype=xml
The response provides information on transfer order ID 445413: 445413 7/29/2002 5:19:29 PM 1 Auto Verification 4 Processing 20.00 1 301770 partnerdomain2 net 9 Awaiting auto verification of transfer request 10.00 0 301771 partnerdomain3 info 9 Awaiting auto verification of transfer request 10.00 0 2 TP_GETORDER 0 Dev Workstation rcom true
3/13/09
505
©2003-2009 Register.com, Inc.
API commands: TP_GetOrder
Related commands PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList
3/13/09
506
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
20
PW
Required
Account login ID Account password
20
TransferOrderDetailID Required
Transfer order detail number returned by calling TP_GetOrder.
10
ResponseType
Format of response. Options are Text (default), HTML, or XML.
4
Optional
Returned parameters and values Param name
Definition
TransferOrderDetailID Transfer order detail number SLD
Second level name
TLD
Top level name
Lock
Lock status of the name
Renew
Renew status of the name
DomainPassword
Password to be set for the name
StatusID
Status ID of this order. See Notes.
3/13/09
507
©2003-2009 Register.com, Inc.
API commands: TP_GetOrderDetail
Param name
Definition
StatusDesc
Status description of this order. See Notes.
Price
Charge amount for this order
UseContacts
Use original contacts or not
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 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
3/13/09
508
©2003-2009 Register.com, Inc.
API commands: TP_GetOrderDetail
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://partnertest.rcomexpress.com/interface.asp?command=TP_GetOrderDetail& uid=rcompartnerid&pw=rcompartnerpw&TransferOrderDetailID=301770&responsetype=xml
The response indicates that tranfer order detail ID 301770 is for the transfer of domain partnerdomain2.net, and provides details of the order: 301770 partnerdomain2 net True False 9 Awaiting auto verification of transfer request 10.00 0 None None None None {BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629} 111 Main Street Hometown US
[email protected] +1.5555555556 John President Doe Partner Domains Inc. +1.5555555555 99999 NY S United States True TP_GETORDERDETAIL 0 Dev Workstation rcom true
3/13/09
509
©2003-2009 Register.com, Inc.
API commands: TP_GetOrderDetail
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
3/13/09
510
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
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.
OrderType
Required
Permitted value is Transfer
8
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
TransferOrderID
ID number of the transfer order
OrderType
Type of the order
TransferOrderDetailID
Transfer order detail ID number, from our records
3/13/09
511
©2003-2009 Register.com, Inc.
Param name
API commands: TP_GetOrderReview
Definition
SLD
Second-level domain name (for example, register in register.com)
TLD
Top-level domain name (extension)
Price
Price that will be charged to this account if the transfer is successful
Lock
Registrar lock setting that was specified in the transfer order
Renew
Auto-renew setting that was specified in the transfer order
DomainPassword
Domain password, if one was specified in the transfer order
UseContacts
Use this account’s default contacts
AuthInfo
EPP Key associated with this domain. Some TLDs require this code to authorize a transfer
RRProcessor
RRProcessor we use
TransferOrderDetailCount
Number of domain names in this order
TransferTotalPrice
Total charges if all domains in this order transfer successfully
AuthInfoStillRequired
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.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=TP_GetOrderReview& uid=rcompartnerid&pw=rcompartnerpw&TransferOrderID=465681&OrderType=Transfer& responsetype=xml
The response is as follows: 465681 Transfer 311389 transferdomain com 8.95 True
3/13/09
512
©2003-2009 Register.com, Inc.
API commands: TP_GetOrderReview
True 1 Partner Domains Inc. 1 8.95 No TP_GETORDERREVIEW en 0 0 1 10 RESELLERTEST e True True +03.00 0.1132813 true
Related commands PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList
3/13/09
513
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
OrderCount
Number of transfer orders that have been submitted for this domain.
TransferOrderIDX X=1 to OrderCount
Transfer order detail number. Indexed X when ResponseType=Text or HTML.
LoginIDX
The account this transfer order is in. Indexed X when ResponseType=Text or HTML.
OrderDateX
The date the order was submitted. Indexed X when ResponseType=Text or HTML.
3/13/09
514
©2003-2009 Register.com, Inc.
API commands: TP_GetOrdersByDomain
Param name
Definition
OrderStatusX
Current status of the order. Indexed X when ResponseType=Text or HTML.
StatusIDX
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.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain2.net, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=TP_GetOrdersByDomain& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain2&tld=net&responsetype=xml
The response indicates that partnerdomain2.net is in transfer order ID 445413, initiated by account rcompartnerid: 445413 rcompartnerid 7/29/2002 5:19:29 PM Processing 4 1 TP_GETORDERSBYDOMAIN 0 Dev Workstation rcom true
3/13/09
515
©2003-2009 Register.com, Inc.
API commands: TP_GetOrdersByDomain
Related commands PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList
3/13/09
516
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
20
Account login ID
PW
Required
Account password
20
IncludeClosedOrders
Optional
Set =1 to return closed orders in the list.
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
TransferOrderID Transfer order number OrderDate
Date the order was entered
OrderTypeID
Type ID of order
OrderTypeDesc
Type of order
StatusID
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
3/13/09
517
©2003-2009 Register.com, Inc.
API commands: TP_GetOrderStatuses
Param name
Definition
StatusDesc
Status description of transfer order. See text descriptions of statuses in StatusID parameter, above.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 rcompartnerid, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=TP_GetOrderStatuses& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response lists the status of every transfer order placed by rcompartnerid. The complete output for transfer order ID 445413 is included here; details of other orders are abridged: 445413 2002-07-29T17:19:29.437 4 Processing 1 Auto Verification . . . False TP_GETORDERSTATUSES 0 Dev Workstation rcom true
3/13/09
518
©2003-2009 Register.com, Inc.
API commands: TP_GetOrderStatuses
Related commands PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList
3/13/09
519
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
QueryFlag
Required
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
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
520
©2003-2009 Register.com, Inc.
API commands: TP_GetTLDInfo
Returned parameters and values Param name
Definition
TLDIDX
ID number for this TLD, used by our database. Indexed X when ResponseType=Text or HTML.
TLDX
Top-level domain name (extension). Indexed X when ResponseType=Text or HTML.
ProtocolX
Registry protocol. Indexed X when ResponseType=Text or HTML.
AbleToLockX
Registry permits locking (user ability to prevent domain from being transfered without authorization)? Indexed X when ResponseType=Text or HTML.
RealTimeX
Registry processes domain registrations in real time? Indexed X when ResponseType=Text or HTML.
TransferableX
Is this TLD transferable? Indexed X when ResponseType=Text or HTML.
HasAuthInfoX
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
Does this Registry permit transfers by fax? Indexed X when ResponseType=Text or HTML.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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=6—TLDs that are both lockable and transferable—and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=TP_GETTLDINFO& uid=rcompartnerid&pw=rcompartnerpw&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: 0 com RRP True True True
3/13/09
521
©2003-2009 Register.com, Inc.
API commands: TP_GetTLDInfo
False True True 1 net RRP True True True False True True 2 org EPP True True True True True True 3 cc RRP True True True False True True 4 TP_GETTLDINFO en 0 0 10 RESELLERTEST rcom +0.00 0.1171875 true
3/13/09
522
©2003-2009 Register.com, Inc.
API commands: TP_GetTLDInfo
Related commands AddToCart TP_CancelOrder TP_CreateOrder TP_GetOrderStatuses TP_SubmitOrder TP_UpdateOrderDetail
3/13/09
523
©2003-2009 Register.com, 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 partners have access to this command.
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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Login ID of the account that requested the transfer (the gaining account)
20
PW
Required
Password of the account that requested the transfer (the gaining account)
20
SLD
Required
Second-level domain name (for example, register in register.com) of the domain to be transferred
63
TLD
Required
Top-level domain name (extension) of the domain to be transferred
15
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
524
©2003-2009 Register.com, Inc.
API commands: TP_ResendEmail
Returned parameters and values Param name Definition Success
True indicates the query was successful
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
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 partnerdomain3.info, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=TP_RESENDEMAIL& uid=rcompartnerid&pw=rcompartnerpw&SLD=partnerdomain3&tld=info&responsetype=xml
In the response, a Success value of True indicates that the query was successful: True TP_RESENDEMAIL en 0 0 1 10 Reseller5 rcom True True +03.00 0.15625 true
3/13/09
525
©2003-2009 Register.com, Inc.
API commands: TP_ResendEmail
Related commands TP_CreateOrder TP_GetDetailsByDomain TP_GetOrderDetail TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder
3/13/09
526
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
TransferOrderDetailID Required
Transfer Order Detail ID. To retrieve this value, use the TP_GetOrder command.
10
ResponseType
Format of response. Options are Text (default), HTML, or XML.
4
Optional
Returned parameters and values Param name
Definition
TransferOrderID New Transfer Order ID Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
527
©2003-2009 Register.com, Inc.
API commands: TP_ResubmitLocked
Param name
Definition
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example Previously, account rcompartnerid 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 rcompartnerid 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://partnertest.rcomexpress.com/interface.asp?command=TP_ResubmitLocked& uid=rcompartnerid&pw=rcompartnerpw&TransferOrderDetailID=607291&responsetype=xml
The Success=True parameter value in the response, and the new TransferOrderID, confirm a successful request: 952245 True TP_RESUBMITLOCKED 0 ResellerTest rcom true
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
3/13/09
528
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
TransferOrderID
Required
Transfer order ID number. To retrieve this value, use the TP_GetOrderStatuses command.
10
EndUserIP
Required for our CC processing
End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.
15
UseCreditCard
Optional for resellers who use our credit card processing AND want to charge this transaction to the credit card included in this query string
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.
3/13/09
529
©2003-2009 Register.com, Inc.
API commands: TP_SubmitOrder
Param name
Obligation Definition
RegistrantFirstName
Required for our CC processing
Registrant first name
60
RegistrantLastName
Required for our CC processing
Registrant last name
60
RegistrantAddress1
Required for our CC processing
First line of Registrant address
60
RegistrantAddress2
Optional for our CC processing
Second line of Registrant address
60
RegistrantCity
Required for our CC processing
Registrant city
60
RegistrantCountry
Required for our CC processing
Registrant country. Two-letter country code is a permitted format.
60
RegistrantPostalCode
Required for our CC processing and for .org names when you supply new Registrant information
Registrant postal code
16
RegistrantPhone
Required for our CC processing
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantEmailAddress Required for our CC processing
Registrant email address
128
CardType
Required for our CC processing
Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover
20
CCName
Required for our CC processing
Cardholder’s name
60
CreditCardNumber
Required for our CC processing
Credit card number
128
CreditCardExpMonth
Required for our CC processing
Expiration month of the credit card, in format MM
2
CreditCardExpYear
Required for our CC processing
Expiration year of the credit card, in format YYYY
4
CVV2
Required for our CC processing
Credit card verification code
4
3/13/09
Max size
530
©2003-2009 Register.com, Inc.
API commands: TP_SubmitOrder
Param name
Obligation Definition
Max size
CCAddress
Required for our CC processing
Credit card billing address
60
ChargeAmount
Required for our CC processing
Amount to charge this credit card. Required format 6 is DD.cc
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=TP_SubmitOrder& uid=rcompartnerid&pw=rcompartnerpw&TransferOrderID=445440&responsetype=xml
In the response, the error count of 0 indicates that the order was submitted successfully: True TP_SUBMITORDER 0 Dev Workstation rcom true
3/13/09
531
©2003-2009 Register.com, Inc.
API commands: TP_SubmitOrder
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
3/13/09
532
©2003-2009 Register.com, 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 Register.com. 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 partners have access to this 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).
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
20
Account login ID
PW
Required
Account password
20
TransferOrderDetailID
Required
Transfer order detail ID. Use the TP_GetOrder command to retrieve this value.
10
Lock
Optional; default is True
Set registrar lock on the name. Permitted values are True or False.
5
Renew
Optional; default is True
Set auto-renew. Permitted values are True or False.
5
DomainPassword
Optional
Set a domain password on the name
60
3/13/09
533
©2003-2009 Register.com, Inc.
API commands: TP_UpdateOrderDetail
Param name
Obligation Definition
Max size
DeleteOrderDetail
Optional
Remove all names from this order,. To remove all names, supply DeleteOrderDetail=Yes
3
RegistrantAddress1
Optional; Required for Fax orders
Registrant address
60
RegistrantAddress2
Optional
Registrant additional address info
60
RegistrantCity
Optional; Required for Fax orders
Registrant city
60
RegistrantCountry
Optional; Required for Fax orders
Registrant country
60
RegistrantEmailAddress
Registrant email address Optional; Required for Fax orders and for .org names for which you are supplying new Registrant information
RegistrantFax
Optional
Registrant fax number. Required format is 20 +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
RegistrantFirstName
Optional; Required for Fax orders
Registrant first name
60
RegistrantLastName
Optional; Required for Fax orders
Registrant last name
60
128
RegistrantJobTitle
Optional
Registrant job title
60
RegistrantOrganizationName
Optional; Required for Fax orders
Registrant organization
60
RegistrantPhone
Optional; Required for Fax orders
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
20
RegistrantPostalCode
Optional
Registrant postal code
16
RegistrantStateProvince
Optional
Registrant state or province
60
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: S state P province
1
UseContacts
Optional
Set =1 to transfer existing WhoIs contacts 1 when the transfer is complete
3/13/09
534
©2003-2009 Register.com, Inc.
API commands: TP_UpdateOrderDetail
Param name
Obligation Definition
Max size
ExtendedAttributes
Required for TLDs that use extended attributes, when UseContacts =0
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
Optional
If set =none then Billing contact will be used, otherwise Registrant contact data must be submitted
3
Tech*
Optional
Technical contact data. See Note.
*
TechUseContact
Optional
If set =none then no contact will be used, 3 otherwise Tech contact data must be submitted.
AuxBilling*
Optional
Auxiliary Billing contact data. See Note.
AuxBillingUseContact
Optional
If set =none then no contact will be used, 3 otherwise Auxbilling contact data must be submitted.
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
*
4
Returned parameters and values Param name
Definition
TransferOrderDetailID
Transfer order detail number
SLD
Second-level domain name
TLD
Top-level domain name
lock
Registrar lock status
renew
Auto-renew status
domainpassword
Password to set for the domain name
statusid
Status ID of the order
statusdesc
Description of the status
price
Transfer price
usecontacts
Use the current contacts flag
Registrant*
Registrant contact data
AuxBilling*
Auxilliary Billing contact data
Tech*
Technical contact data
Admin*
Administrative contact data
Billing*
Billing contact data
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
535
©2003-2009 Register.com, Inc.
API commands: TP_UpdateOrderDetail
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://partnertest.rcomexpress.com/interface.asp?command=TP_UpdateOrderDetail& uid=rcompartnerid&pw=rcompartnerpw&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: 301770 partnerdomain2 net True True 10 Unable to retrieve current domain contacts from UW 10.00 0 {BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629} 111 Main Street Hometown US
[email protected] 555-555-5556 John President Doe Partner Domains Inc. 555-555-5555 99999 NY S None None None {BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629} 111 Main Street
3/13/09
536
©2003-2009 Register.com, Inc.
API commands: TP_UpdateOrderDetail
Hometown US
[email protected] 555-555-5556 John President Doe Partner Domains Inc. 555-555-5555 99999 NY S United States True {BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629} True TP_UPDATEORDERDETAIL 0 Dev Workstation rcom true
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
3/13/09
537
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
NewUID
Required for changing the password of a retail subaccount
Retail subaccount login ID. Permitted format is alphanumeric characters. Must be unique in our system
20
NewPW
Required for changing the password of a retail subaccount
Desired password for the retail subaccount for the future. Permitted values are 6 to 20 alphanumeric characters and symbols. Not permitted: space, #, %, &
20
ConfirmNewPW
Required for changing the password of a retail subaccount
Confirm desired password for the retail subaccount for the future
20
3/13/09
538
©2003-2009 Register.com, Inc.
API commands: UpdateAccountInfo
Param name
Obligation
Definition
Max size
AuthQuestionType
Required
Type of question. Permitted values: 10 smaiden mother’s maiden name sbirth city of birth ssocial last 4 digits of SSN shigh high school
AuthQuestionAnswer
Required
The answer to the question type (mother's maiden name, city of birth, last 4 digits of social security or high school)
50
Account
Optional
Account ID of the account to be updated
11
RegistrantOrganizationName
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
RegistrantFirstName
Required
Registrant first name
60
RegistrantLastName
Required
Registrant last name
60
RegistrantJobTitle
Required if Registrant job title RegistrantOrgan izationName is supplied
60
60
RegistrantAddress1
Required
Registrant Address
60
RegistrantAddress2
Optional
Registrant additional address info
60 60
RegistrantCity
Required
Registrant city
RegistrantStateProvinceChoice
Optional
Registrant state or province choice: 1 S state P province
RegistrantStateProvince
Optional
Registrant state or province
60
RegistrantPostalCode
Optional
Registrant postal code
16
RegistrantCountry
Optional
Registrant country
60
RegistrantEmailAddress
Required
Email address for WhoIs
128
RegistrantEmailAddress_Contact
Optional
Email address for us to contact to you about your domain name account
128
RegistrantPhone
Required
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
17
RegistrantFax
Required if RegistrantOrgan izationName is supplied
Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.
17
3/13/09
539
©2003-2009 Register.com, Inc.
API commands: UpdateAccountInfo
Param name
Obligation
Definition
Max size
CardType
Required if updating credit card information of a retail account
Type of credit card
20
CCName
Required if updating credit card information of a retail account
Cardholder's name
60
CreditCardNumber
Required if updating credit card information of a retail account
Customer's credit card number
128
CreditCardExpMonth
Required if updating credit card information of a retail account
Credit card expiration month
2
CreditCardExpYear
Required if updating credit card information of a retail account
Credit card expiration year
4
CVV2
Required if updating credit card information of a retail account
Credit card verification code
4
CCAddress
Required if updating credit card information of a retail account
Credit card billing address
60
CCZip
Required if updating credit card information of a retail account
Credit card billing postal code
15
CCCountry
Required if updating credit card information of a retail account
Credit card billing country
60
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
540
©2003-2009 Register.com, Inc.
API commands: UpdateAccountInfo
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://partnertest.rcomexpress.com/interface.asp?command=UpdateAccountInfo& uid=rcompartnerid&pw=rcompartnerpw&NewUID=rcompartnerid2& NewPW=rcompartnerpw2&ConfirmNewPW=rcompartnerpw2& 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=Partner+Domains+Inc.&RegistrantPhone=+1.5555555555& RegistrantPostalCode=99999&RegistrantStateProvince=NY&RegistrantStateProvinceChoice=S& RegistrantNexus=United+States&RegistrantPurpose=&responsetype=xml
The response confirms the Successful update of account information: Successful Partner Domains Inc. President John Doe 111 Main St. Hometown NY S 99999 US 5555555555 5555555556
[email protected] [email protected] rcompartnerid rcompartnerpw smaiden Jones 217-no-0647 True True
3/13/09
541
©2003-2009 Register.com, Inc.
API commands: UpdateAccountInfo
UPDATEACCOUNTINFO 0 Dev Workstation rcom true
Related commands CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory UpdateCusPreferences
3/13/09
542
©2003-2009 Register.com, 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 partners have access to this 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 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
LoginID
Optional
Subaccount login ID (use 20 GetAccountInfo to retrieve the subaccount login ID)
Account
Required
11 Subaccount ID number (use GetAccountInfo to retrieve the subaccount ID number; format is NNN-aa-NNNN)
AcctType
Required
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.
3/13/09
543
©2003-2009 Register.com, Inc.
API commands: UpdateAccountPricing
Param name
Obligation Definition
Max size
TLDprice
Optional
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.
5000.00
TLDrenew
Optional
Price for renewing a domain name, in DD.cc format
5000.00
TLDtransfer
Optional
Price for transferring a domain 5000.00 name and extending its expiration date by one year, in DD.cc format
DNSHosting
Optional
Price for one year of DNS hosting, in DD.cc format
5000.00
POP3
Optional
Price for a 10-pak of POP3 mailboxes, in DD.cc format
5000.00
DotNameBundle
Optional
Price of a .name domain plus email service from the .name Registry, in DD.cc format
5000.00
45_valueadd
Optional
Price of email forwarding, in DD.cc format
5000.00
47_valueadd
Optional
Price of URL forwarding, in DD.cc format
5000.00
WPPS
Optional
Price for one year of Whois Privacy Protection Service, in DD.cc format
5000.00
Certificate-GeoTrust-QuickSSL
Optional
Price for a one-year GeoTrust QuickSSL certificate, in DD.cc format
5000.00
Certificate-GeoTrust-QuickSSL-Premium
Optional
Price for a one-year GeoTrust 5000.00 QuickSSL Premium certificate, in DD.cc format
Certificate-GeoTrust-TrueBizID
Optional
Price for a one-year GeoTrust True BusinessID certificate, in DD.cc format
5000.00
Certificate-GeoTrust-TrueBizID-Wildcard Optional
Price for a one-year GeoTrust True BusinessID Wildcard certificate, in DD.cc format
5000.00
Certificate-GeoTrust-TrueBizID-EV
Optional
Price for a one-year GeoTrust True BusinessID with EV certificate, in DD.cc format
5000.00
Certificate-RapidSSL-RapidSSL
Optional
Price for a one-year RapidSSL certificate, in DD.cc format
5000.00
WSCBasic
Optional
Price for WebSite Creator Basic package, in DD.cc format
5000.00
WSCFull
Optional
Price for WebSite Creator Full package, in DD.cc format
5000.00
WSCEcommerce
Optional
Price for WebSite Creator 5000.00 eCommerce package, in DD.cc format
Hosted-Exchange-Mailbox
Optional
Price for one Hosted Microsoft 5000.00 Exchange mailbox, per month, in DD.cc format
3/13/09
544
©2003-2009 Register.com, Inc.
API commands: UpdateAccountPricing
Param name
Obligation Definition
Max size
Hosted-Exchange-Extra-Storage
Optional
Price for 100MB of extra 5000.00 storage on the Hosted Microsoft Exchange server, per month, in DD.cc format
Hosted-Exchange-BlackBerry
Optional
5000.00 Price for delivery to one BlackBerry device, per month, in DD.cc format
Hosted-Exchange-BlackBerry-Setup-Fee
Optional
Setup fee for BlackBerry support, a one-time fee per device, in DD.cc format
5000.00
Hosted-Exchange-GoodLink
Optional
Price for delivery to one Good Mobile Messaging device, per month, in DD.cc format
5000.00
Hosted-Exchange-GoodLink-Setup-Fee
Optional
Setup fee for Good Mobile Messaging support, a onetime fee per device, in DD.cc format
5000.00
Hosted-Exchange-ActiveSync
Optional
5000.00 Price for delivery to one ActiveSync device, per month, in DD.cc format
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Account
Subaccount ID
AccountType
Subaccount type
Count
Number of prices modified
Status
Success status for this query
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
3/13/09
545
©2003-2009 Register.com, Inc.
API commands: UpdateAccountPricing
Example The following query sets prices for several products. It requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?uid=rcompartnerid& pw=rcompartnerpw&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: 154-dz-5567 reseller 5 Successful UPDATEACCOUNTPRICING 0 RESELLERTEST rcom True True true
Related commands HE_GetPricing PE_GetCustomerPricing PE_GetDomainPricing PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing PE_SetPricing SetResellerServicesPricing SetResellerTLDPricing WSC_GetPricing
3/13/09
546
©2003-2009 Register.com, 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 partners have access to this command.
Constraints The query must meet the following requirements: •
The login ID and password must be valid.
•
The item must be in the customer’s shopping cart.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
ItemIDX(X=1 Required to NumberOfItems)
Input value is the six-digit cart item ID. Retrieve this number 10 using the GetCartContent command.
ItemStatusX
Optional
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.
ItemQtyX
Required
New quantity for the item
4
RenewX
Optional
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
ClearItems
Optional
Toggle all items in cart to status I (Inactive). Permitted value 3 is Yes.
ActivateItems
Optional
Toggle all items in cart to status A (Active). Permitted value is Yes.
3
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
547
©2003-2009 Register.com, Inc.
API commands: UpdateCart
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=updatecart& uid=rcompartnerid&pw=rcompartnerpw& ItemID1=365690&ItemStatus1=on&ItemQty1=1&Renew1=1&ResponseType=xml
In the response, an ErrCount value 0 indicates that the query was successful: UPDATECART 0 Dev Workstation rcom true
Related commands AddBulkDomains AddToCart DeleteFromCart GetCartContent InsertNewOrder PurchasePreview
3/13/09
548
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
DefPeriod
Required
Default period for auto-renew and registrar lock settings, in years. A domain’s registration period cannot extend more than 10 years beyond today.
2
RegLock
Optional; default is on
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.
3
AutoRenew
Optional; default is off
AutoRenew=on renews domain names automatically. AutoRenew=off does not renew domain names automatically.
3
AutoPakRenew
Optional; default is 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.
3
3/13/09
549
©2003-2009 Register.com, Inc.
API commands: UpdateCusPreferences
Param name
Obligation Definition
Max size
EMailForwardRenew
Optional; default is off
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.
3
URLForwardingRenew Optional; default is off
URLForwardingRenew=on renews URL forwarding automatically. URLForwardingRenew=off does not renew URL forwarding automatically.
3
AllowDNS
Optional; default is 1
Allow domain name servers. Options are 0 and 1.
1
UseDNS
Optional; default is 0
1 Which name servers a domain is using. 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.
DNSY Y=1, 2, 3, . . .
Optional
Use name of domain name server. For example, DNS1=dns01.gpn.register.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.
16
UseParentDefault
Optional
Use the same host records as this account’s parent account? Permitted values are: 0 Do not use parent account’s defaults 1 Use parent account’s defaults
1
RecordTypeX X=1, 2, 3, . . .
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
5
3/13/09
550
©2003-2009 Register.com, Inc.
API commands: UpdateCusPreferences
Param name
Obligation Definition
Max size
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
HostNameX
Optional
Name of host record X, for example, HostName1=www
60
ShowPopUps
Optional; default is 1
Show menus. ShowPopUps=0 hides menus. ShowPopUps=1 shows menus.
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Update
A return value of Successful indicates that customer preferences were successfully updated.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
3/13/09
551
©2003-2009 Register.com, Inc.
API commands: UpdateCusPreferences
Example The following query requests the updating of several customer preference settings, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=UPDATECUSPREFERENCES& uid=rcompartnerid&pw=rcompartnerpw&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: UPDATECUSPREFERENCES 0 Dev Workstation rcom 0 0
Related commands CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetConfirmationSettings GetCusPreferences GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory SetPakRenew UpdateAccountInfo UpdateRenewalSettings
3/13/09
552
©2003-2009 Register.com, 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 partners have access to this 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 registrar’s 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
DomainName
Required
Domain Name (for example, example.com)
65
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition Status
Reactivation status.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
553
©2003-2009 Register.com, Inc.
API commands: UpdateExpiredDomains
Param name Definition Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 partnerdomain.com, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=UpdateExpiredDomains& uid=rcompartnerid&pw=rcompartnerpw&DomainName=partnerdomain.com&responsetype=xml
In the response, the Status value indicates a successful reactivation: REACTIVATION PROCESSED SUCCESSFULLY! The orderid is 156514444. UPDATEEXPIREDDOMAINS 0 ResellerTest rcom true
Related commands Extend Extend_RGP GetDomainExp GetExtendInfo GetRenew InsertNewOrder SetRenew
3/13/09
554
©2003-2009 Register.com, Inc.
API commands: UpdateMetaTag
UpdateMetaTag Description Definition Add or update the HTML metatags for one of a domain’s host records.
Usage Use this command to raise the probability that a search engine will find this domain.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
MetaTagHostID
Required
Metatag host ID, our internal tracking number. You can retrieve host IDs using the GetRegHosts command.
8
TitleBar
Recommended to optimize search ranking
Content to display in the browser title bar. Replace spaces 100 with +.
SiteDescription
Recommended to optimize search ranking
Content to display in search engine results. Replace spaces with +.
250
Keywords
Recommended to optimize search ranking
List of keywords for search engines. Separate keywords with +.
250
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
555
©2003-2009 Register.com, Inc.
API commands: UpdateMetaTag
Returned parameters and values Param name
Definition
TitleBar
New title to display in browser title bar
SiteDescription
New description to display in search engine results
Keywords
New search-engine keywords for this host ID
DomainNameID
9-digit domain name ID, our internal tracking number
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=UpdateMetaTag& uid=rcompartnerid&pw=rcompartnerpw&sld=partnerdomain&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: E False MY COOL TITLE MY SITE DESCRIPTION MY SITE KEYWORDS 152533676 UPDATEMETATAG 0 RESELLERTEST rcom False True true
3/13/09
556
©2003-2009 Register.com, Inc.
API commands: UpdateMetaTag
Related commands GetHosts GetMetaTag GetRegHosts SetHosts
3/13/09
557
©2003-2009 Register.com, Inc.
API commands: UpdateNameServer
UpdateNameServer Description Definition Change the IP address of a name server in the Registry’s records.
Usage Use this command when the IP address of a name server changes.
Availability All partners have access to this 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.
•
Register.com must be the authoritative registrar (in the Registry’s 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
20
Required
Account login ID
PW
Required
Account password
20
OldIP
Required
Old IP address of the name server in the Registry’s records
15
NewIP
Required
New IP address of the name server in the Registry’s records
15
NS
Required
Use name of the name server, in the Registry’s records
84
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition NSSuccess
1 indicates that the name server IP update is successful
RRPCode
Registry processing status code
3/13/09
558
©2003-2009 Register.com, Inc.
API commands: UpdateNameServer
Param name Definition RRPText
Text explanation of registry code
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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.partnerdomain.com and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=updatenameserver& uid=rcompartnerid&pw=rcompartnerpw&OldIP=127.0.0.1&NewIP=127.0.0.2& NS=dns1.partnerdomain.com&responsetype=xml
In the response, the NsSuccess value 1 and RRPText value Command completed successfully confirm that the query was successful: 1 200 Command completed successfully UPDATENAMESERVER 0 RESELLERTEST rcom True True true
Related commands CheckNSStatus DeleteNameServer GetDNS GetDNSStatus ModifyNS ModifyNSHosting RegisterNameServer
3/13/09
559
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20 20
PW
Required
Account password
NotifyAmount
Required
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
ResponseType
Optional
Format of response. Options are Text (default), HTML, 4 or XML.
Returned parameters and values Param name Definition Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
560
©2003-2009 Register.com, Inc.
API commands: UpdateNotificationAmount
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://partnertest.rcomexpress.com/interface.asp?command=UpdateNotificationAmount& uid=rcompartnerid&pw=rcompartnerpw&NotifyAmount=505&responsetype=xml
In the response, an ErrCount value 0 confirms that the query was successful: Successful UPDATENOTIFICATIONAMOUNT eng 0 0 10 RESELLERTEST rcom +0.00 0.0703125 true [CDATA]
Related commands GetBalance RefillAccount
3/13/09
561
©2003-2009 Register.com, 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 Register.com account to another.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
PushToLoginID Required
LoginID of the account to push the names into
16
DomainList
Required
CRLF-delimited list of domain names (URLEncode value for CRLF is %0D%0A).
4000
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
SuccessfulPush
True if successful or False otherwise
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
3/13/09
562
©2003-2009 Register.com, Inc.
API commands: UpdatePushList
Param name
Definition
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query requests that partnerdomain2.net and partnerdomain3.info be pushed to account giambi, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=UpdatePushList& uid=rcompartnerid&pw=rcompartnerpw&PushToLoginID=giambi& domainlist=partnerdomain2.net%0D%0Apartnerdomain3.info&responsetype=xml
In the response, the SuccessfulPush values of Yes indicate that each domain was pushed successfully: partnerdomain2.net Valid Yes Yes partnerdomain3.info Valid Yes Yes UPDATEPUSHLIST 0 ResellerTest rcom true
3/13/09
563
©2003-2009 Register.com, 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
3/13/09
564
©2003-2009 Register.com, 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
RenewalSetting
Optional
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
1
RenewalBCC
Optional
BCC me on all email correspondence sent to my customers. Permitted values are: 0 Do not BCC me 1 BCC me
1
3/13/09
565
©2003-2009 Register.com, Inc.
API commands: UpdateRenewalSettings
Param name
Obligation
Definition
Max size
AcceptTerms
Optional; must be accepted before you can use our credit card processing services
Do I accept Register.com’s credit card processing agreement? Permitted values are: 0 I do not accept Register.com’s credit card processing agreement 1 I accept Register.com’s credit card processing agreement
1
URL
Recommended when RenewalSetting =1
URL where customers can renew their domains; use format www.DomainName.com
63
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
AcceptTermsStatus
Success status of updating credit card terms setting
RenewalSetting
Success status of updating renewal settings
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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://partnertest.rcomexpress.com/interface.asp?command=UPDATERENEWALSETTINGS& uid=rcompartnerid&pw=rcompartnerpw&RenewalSetting=2&RenewalBCC=1&AcceptTerms=1& URL=www.partnerdomain.com&ResponseType=XML
In the response, the return values Successful and the ErrCount value 0 confirm that the query was successful: Successful Successful UPDATERENEWALSETTINGS en 0
3/13/09
566
©2003-2009 Register.com, Inc.
API commands: UpdateRenewalSettings
0 10 LOCALHOST rcom +0.00 0.046875 true
Related commands GetCusPreferences UpdateCusPreferences
3/13/09
567
©2003-2009 Register.com, 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 partners have access to this command.
Constraints The query must meet the following requirements: •
The domain name must exist.
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation Definition
Max size
UID
Required
20
Account login ID
PW
Required
Account password
20
SLD
Required
Second-level domain name (for example, register in register.com)
63
TLD
Required
Top-level domain name (extension)
15
DomainPassword
Required
Password to access and manage the domain name.
60
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name Definition RegistrarHold
The enabled status of a domain. If RegistrarHold is True, the domain is disabled.
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
3/13/09
568
©2003-2009 Register.com, Inc.
API commands: ValidatePassword
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 partnerdomain2pw is the domain password for partnerdomain2.net, and requests the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=validatepassword& uid=rcompartnerid&pw=rcompartnerpw& sld=partnerdomain2&tld=net&domainpassword=partnerdomain2pw&responsetype=xml
In the response, the error count of 0 confirms that partnerdomain2pw is the domain password for partnerdomain2.net: False VALIDATEPASSWORD 0 Dev Workstation rcom true
Related commands GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain
3/13/09
569
©2003-2009 Register.com, 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 WSC account. This command retrieves the URL to the Web site creation wizard for this WSC account.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Account
Required
Name of WSC account. Use the WSC_GetAllPackages command to retrieve a list of WSC accounts.
14
Language
Optional; default is Eng
Language in which to launch the WSC wizard. Permitted values are: Eng English Spa Spanish Ger German Por Portuguese Fre French Ita Italian
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
570
©2003-2009 Register.com, Inc.
API commands: WSC_GetAccountInfo
Returned parameters and values Param name
Definition
WebHostID
Individual identification number for this WSC account
HostAccount
The individual account name of this WSC account
WebStorage
Storage space available to this account
BandWidth
Monthly bandwidth available to this account
SQLSize
Database space available to this account
DatabaseType
Type of database configured for this account
POPMailboxes
POP mailboxes for this account
Overage
Overage option for this account
BillingDate
Billing date of this account
Status
Active status of this account
OSType
Operating system of our server on which your WSC account resides
Terminate
Is this account flagged for termination?
TerminateDate
If flagged for termination, on what date?
HasWSC
Does this account have WSC?
WSCEnabled
Is WSC enabled for this account?
WSCLaunchURL
The URL for the WSC wizard for this account
WSCCountry
The country for the WSC wizard for this account
WSCLanguage
The language for the WSC wizard for this account
CurrentPlanPrice
Monthly price for WSC
CanUpgrade
Is this account eligible for upgrade?
WSCFullPrice
Price for WSC Full
WSCECommercePrice
Price for WSC eCommerce
WSCVersion
WSC version
HostHeaderDomains
Host header domains
HasHostHeaders
Do these domains have host headers?
WSCPath
Return value WSC indicates that this is a Web hosting account that subscribes to WSC
SiteURL
URL of the WSC-built Web Site for this account
IsLWSC
Is this a WSC Lite free account?
WSCSiteID
Our identification number for this WSC site
PointedTo
Is the WSC-built Web site pointing to SiteURL?
WSCSiteID
Our identification number for this WSC site
EmailAddress
Email address of WSC account subscriber
HTTPURL
Domain name tied to WSC
NextBillPeriod
Next billing period
Month
For multi-month discounts, the number of months customer pays for to receive this discount
PromoID
For multi-month discounts, the promo code for this discount
DiscountPercent
For multi-month discounts, the discount percentage
DiscountPlanCnt
Number of discount plans listed here
CanUpdate
Can this billing period be changed?
DeleteDate
Scheduled delete date for this WSC Web site
AvailableHeaderDomains
Scheduled delete date for this WSC Web site
AvailableDomainList
Scheduled delete date for this WSC Web site
AvailableDomainCount
Scheduled delete date for this WSC Web site
3/13/09
571
©2003-2009 Register.com, Inc.
Param name
API commands: WSC_GetAccountInfo
Definition
Command
Name of command executed
Language
Language of the WebSite Creator wizard
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The 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 WSC stand-alone account, and sends the response in XML format: http://partnertest.rcomexpress.com/Interface.asp?command=WSC_GETACCOUNTINFO& uid=rcompartnerid&pw=rcompartnerpw&account=LWSC123x4567&responsetype=xml
The response is as follows: 1398 LWSC123x4567 1/14/2007 Active False True True http://wsc.ehost-services.com/servlet/ CMWizardLN?flush=F7480EBA6798052499D1BA835B436021 15.05 False Ecommerce partnerdomain.com 152566773 True
3/13/09
572
©2003-2009 Register.com, Inc.
API commands: WSC_GetAccountInfo
True partnerdomain2.net 318282340 True False partnerdomain3.info 318282341 True True True WSC http://www.partnerdomain.com False 100 True 3 53 10 6 54 15 12 55 20 3 True False 836 WSC_GETACCOUNTINFO eng 0 0 10 RESELLERTEST rcom +0.00
3/13/09
573
©2003-2009 Register.com, Inc.
API commands: WSC_GetAccountInfo
7.546875 true
Related commands AddToCart GetAllDomains PurchaseServices WSC_GetAllPackages WSC_GetPricing WSC_Update_Ops
3/13/09
574
©2003-2009 Register.com, Inc.
API commands: WSC_GetAllPackages
WSC_GetAllPackages
Description Definition Retrieve a list of all WSC accounts.
Usage Use this command to list all WSC 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 partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size 20
UID
Required
Account login ID
PW
Required
Account password
20
GetLaunchURL
Optional; default is 1
Include URL to launch WSC wizard in response? Permitted values are 1 to include URL, 0 to omit.
1
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
Returned parameters and values Param name
Definition
WebHostID
Individual identification number for this WSC account
HostAccount
The individual account name of this WSC account
WebStorage
Storage space available to this account
BandWidth
Monthly bandwidth available to this account
SQLSize
Database space available to this account
DatabaseType
Type of database configured for this account
POPMailboxes
POP mailboxes for this account
3/13/09
575
©2003-2009 Register.com, Inc.
Param name
API commands: WSC_GetAllPackages
Definition
Overage
Overage option for this account
BillingDate
Billing date of this account
Status
Active status of this account
OSType
Operating system of our server on which your account resides
Terminate
Is this account flagged for termination?
TerminateDate
If flagged for termination, on what date?
HasWSC
Does this account have WSC?
WSCEnabled
Is WSC enabled for this account?
WSCLaunchURL
The URL for the WSC wizard for this account
CurrentPlanPrice
Monthly price for WSC
CanUpgrade
Is this account eligible for upgrade?
WSCFullPrice
Price for WSC Full
WSCECommercePrice Price for WSC eCommerce WSCVersion
WSC version
Domain
Name of domain associated with this account
DomainNameID
Our identification number for this domain name
WSCOnlyHeaders
Is this domain associated with the WSC Web site?
HasPOP
Does this domain have POP email associated with it?
HasHostHeaders
Do these domains have host headers?
WSCPath
Return value WSC indicates that this is a Web hosting account that subscribes to WSC
SiteURL
URL of the WSC-built Web site for this account
IsLWSC
Is this a WSC Lite free account?
WSCSiteID
Our identification number for this WSC site
PointedTo
Is the WSC-built Web site pointing to SiteURL?
EmailAddress
Email address of WSC subscriber
HTTPURL
Domain name associated with this WSC account
CurrentBillPeriod
Current billing period
NextBillPeriod
Next billing period
Month
For multi-month discounts, the number of months customer pays for to receive this discount
PromoID
For multi-month discounts, the promo code for this discount
DiscountPercent
For multi-month discounts, the discount percentage
DiscountPlanCnt
Number of discount plans listed here
CanUpdate
Can this billing period be changed?
DeleteDate
Scheduled delete date for this WSC Web site
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
3/13/09
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.
576
©2003-2009 Register.com, Inc.
API commands: WSC_GetAllPackages
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 WSC accounts, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=WSC_GETALLPACKAGES& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
The response includes a wide variety of information on each WSC account: 1398 test121406 1/14/2007 Active False True True http://wsc.ehost-services.com/servlet/ CMWizardLN?flush=7D2643832113A75809908A9F1913DC72 15.05 False Ecommerce partnerdomain.com 152566773 True True partnerdomain2.net 318282340 True False partnerdomain3.info 318282341 True True True WSC http://www.partnerdomain.com False
3/13/09
577
©2003-2009 Register.com, Inc.
API commands: WSC_GetAllPackages
100 True 3 53 10 6 54 15 12 55 20 3 True . . .
Related commands AddToCart GetAllDomains PurchaseServices WSC_GetAccountInfo WSC_GetPricing WSC_Update_Ops
3/13/09
578
©2003-2009 Register.com, Inc.
API commands: WSC_GetPricing
WSC_GetPricing
Description Definition Retrieve this account’s 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.
Availability All partners have access to this 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://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
GetRetail
Optional
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.
4
Language
Optional; default is Eng
In what language should the WSC wizard launch? Permitted values are: Eng English Fre French Ger German Ita Italian Por Portuguese Spa Spanish
4
ResponseType
Optional
Format of response. Options are Text (default), HTML, or XML.
4
3/13/09
579
©2003-2009 Register.com, Inc.
API commands: WSC_GetPricing
Returned parameters and values Param name
Definition
LWSCBasicPrice
This account’s wholesale cost or retail price for the WSC Basic package (supports only the WSC Web site)
LWSCFullPrice
This account’s wholesale cost or retail price for the WSC Full package
LWSCECommercePrice This account’s wholesale cost or retail price for the WSC eCommercepackage WSCDemoURL
URL of our Web Site Creator demo
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example The following query retrieves this account’s wholesale costs for Web Site Creator packages, and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=WSC_GETPRICING& uid=rcompartnerid&pw=rcompartnerpw&responsetype=xml
In the response, WSC prices and an ErrCount value 0 confirm that the query was successful: 2.85 5.75 9.25 2.85 5.75 11.75 http://wsc.ehost-services.com/create_demo_account.jsp?productId= WSCENOSSSLYTC215&clientId=RRENOS999JZT4SYQ&language=en&country=US& wl_name=wl_rcom&demoCallbackUrl= WSC_GETPRICING en 0 0 10 RESELLERTEST rcom
3/13/09
580
©2003-2009 Register.com, Inc.
API commands: WSC_GetPricing
+0.00 0.1484375 true
Related commands AddToCart GetAllDomains PurchaseServices WSC_GetAccountInfo WSC_GetAllPackages WSC_Update_Ops
3/13/09
581
©2003-2009 Register.com, Inc.
API commands: WSC_Update_Ops
WSC_Update_Ops Description Definition Upgrade Web Site Creator.
Usage Use this command to upgrade Web Site Creator accounts that are at least Lite Basic. The following table lays out the upgrade path for WSC products (Lite, Lite Basic, Lite Full, and Lite eCommerce):
If you have:
And want:
And purchase in this way:
Use this command:
No WSC
WSC Lite
No purchase necessary for WSC Lite
ServiceSelect
No WSC
Lite Basic Lite Full Lite eCommerce
Real time
PurchaseServices
No WSC
Lite Basic Lite Full Lite eCommerce
Shopping cart
ServiceSelect to create Lite, then AddToCart to upgrade to higher plan
Lite Basic Lite Full
Upgrade to a higher plan
Billing amount is deducted from your account balance
WSC_Update_Ops in the last
Lite Basic Lite Full Lite eCommerce
Change to a different billing cycle
Billing amount is deducted from your account balance
WSC_Update_Ops in the last
month of the current billing cycle month of the current billing cycle
You cannot downgrade Web Site Creator from a higher to a lower version.
Availability All partners have access to this command.
Constraints The query must meet the following requirements:
3/13/09
•
The login ID and password must be valid.
•
The Web Site Creator account must belong to this domain name account.
•
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.
582
©2003-2009 Register.com, Inc.
API commands: WSC_Update_Ops
Input parameters Build the query string using this syntax: http://partnertest.rcomexpress.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword¶mname=paramvalue&nextparamname=nextparamvalue
Param name
Obligation
Definition
Max size
UID
Required
Account login ID
20
PW
Required
Account password
20
Account
Required
Name of LWSC account. Must be an account name with format LWSCNNNxNNNN
14
NewLWSCPlan
Optional; default is current plan
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.
LWSCBillCycle
Optional; default is current billing cycle
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.
ResponseType
Optional
Format of response. Options are Text (default), 4 HTML, or XML.
Returned parameters and values Param name
Definition
AccountStatusID
1 indicates a valid, active account.
Successful
True indicates that the query executed successfully
PlanUpdated
True indicates that the LWSC plan was successfully upgraded
BillingCycleUpdated
True indicates that the LWSC billing cycle was successfully changed
Command
Name of command executed
ErrCount
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x)
Error messages explaining the failure. These can be presented as is back to the client.
Done
True indicates this entire response has reached you successfully.
Notes •
The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
•
Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
3/13/09
583
©2003-2009 Register.com, Inc.
API commands: WSC_Update_Ops
Example The following query upgrades Web Site Creator to eCommerce and sends the response in XML format: http://partnertest.rcomexpress.com/interface.asp?command=WSC_Update_Ops& uid=rcompartnerid&pw=rcompartnerpw&Account=LWSC337x8128& NewLWSCPlan=LWSCEcommerce&LWSCBillCycle=6&ResponseType=XML
In the response, the ErrCount value 0 confirms that the query was successful: 1 True True True True WSC_UPDATE_OPS eng 0 0 10 RESELLERTEST rcom +0.00 0.078125 true
Related commands AddToCart Purchase PurchaseServices ServiceSelect WSC_GetAccountInfo WSC_GetAllPackages WSC_GetPricing
3/13/09
584
©2003-2009 Register.com, Inc.
Index
Index A account ID validating . . . . . . . . . . . . accounting CommissionAccount . . . . . GetBalance . . . . . . . . . . . PE_GetCustomerPricing . . PE_GetDomainPricing . . . PE_GetPOPPrice . . . . . . . PE_GetProductPrice . . . . . PE_GetResellerPrice . . . . PE_GetRetailPrice . . . . . . PE_GetRetailPricinge . . . . 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 . GetTLDList . . . . . . . . . . . GetTransHistory . . . . . . . .
3/13/09
. . . . . . . . . 69 ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... .........
75 147 347 350 353 355 358 361 364 370 471 474 543
......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... .........
37 69 81 86 109 130 133 135 141 157 164 170 177 189 241 244 270 273 282 290 293 296 299
RefillAccount . . . . . . . . . RemoveTLD . . . . . . . . . . RPT_GetReport . . . . . . . SendAccountEmail . . . . . UpdateAccountInfo . . . . . UpdateCusPreferences . . UpdateNotificationAmount . UpdateRenewalSettings . . validating user ID . . . . . . AddBulkDomains . . . . . . . . . AddContact . . . . . . . . . . . . . AddToCart . . . . . . . . . . . . . . AdvancedDomainSearch . . . . auctions Check . . . . . . . . . . . . . . authorization key GetContacts . . . . . . . . . . AuthorizeTLD . . . . . . . . . . . . automatic renewals GetCusPreferences . . . . . GetRenew . . . . . . . . . . . SetPakRenew . . . . . . . . SetRenew . . . . . . . . . . . UpdateCusPreferences . . UpdateRenewalSettings . . availability checking domain names . .
. . . . . . . . . . 411 . . . . . . . . . . 418 . . . . . . . . . . 429 . . . . . . . . . . 434 . . . . . . . . . . 538 . . . . . . . . . . 549 . . . . . . . . . . 560 . . . . . . . . . . 565 . . . . . . . . . . 69 . . . . . . . . . . 15 . . . . . . . . . . 18 . . . . . . . . . . 21 . . . . . . . . . . 31 . . . . . . . . . . 66 . . . . . . . . . . 160 . . . . . . . . . . 37 . . . . . . . . . . 164 . . . . . . . . . . 267 . . . . . . . . . . 458 . . . . . . . . . . 468 . . . . . . . . . . 549 . . . . . . . . . . 565 . . . . . . . . . . 66
B balances GetBalance . . . . . . . . . . . . . . . . . RefillAccount . . . . . . . . . . . . . . . . UpdateNotificationAmount . . . . . . . . bulk PE_GetPOPPrice . . . . . . . . . . . . . PurchasePOPBundle . . . . . . . . . . . purchasing domains . . . . . . . . . . . . pushing domains to another account . BundleID retrieving . . . . . . . . . . . . . . . . . . .
. . . 147 . . . 411 . . . 560 . . . 353 . . . 393 . . . 15 . . . 562 . . . 249
585
©2003-2009 Register.com, Inc.
Index:
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 . . . . . Check . . . . . . . . . . . . . . . . checking out DeleteFromCart . . . . . . . CheckLogin . . . . . . . . . . . . . CheckNSStatus . . . . . . . . . . checkout Purchase . . . . . . . . . . . PurchasePreview . . . . . . UpdateCart . . . . . . . . . . CommissionAccount . . . . . . . configure GetExtAttributes . . . . . . . configuring extended attributes Preconfigure . . . . . . . . . contact information AddContact . . . . . . . . . . Contacts . . . . . . . . . . . . DeleteContact . . . . . . . . GetAddressBook . . . . . . GetAllAccountInfo . . . . . GetContacts . . . . . . . . . GetForwarding . . . . . . . . GetServiceContact . . . . . GetSubaccountsDetailList GetWhoisContact . . . . . . ServiceSelect . . . . . . . . Contacts . . . . . . . . . . . . . . . contents
3/13/09
. . . . . . . . . . 106 . . . . . . . . . . 491 .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... ..........
15 21 95 149 330 380 396 547 40 47 50 54 57 60 63
.......... .......... .......... .......... .......... .......... .......... .......... .......... ..........
40 47 50 54 57 60 63 154 399 66
. . . . . . . . . . 95 . . . . . . . . . . 69 . . . . . . . . . . 72 .......... .......... .......... ..........
380 396 547 75
. . . . . . . . . . 211 . . . . . . . . . . 374 .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... ..........
18 77 91 137 141 160 218 279 293 303 436 77
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 . . . . . . . . . .
D
DeleteAllPOPPaks . . . . . . . DeleteContact . . . . . . . . . . DeleteCustomerDefinedData . DeleteFromCart . . . . . . . . . DeleteHostedDomain . . . . . . DeleteNameserver . . . . . . . DeletePOP3 . . . . . . . . . . . . DeletePOPPak . . . . . . . . . . DeleteRegistration . . . . . . . . DeleteSubaccount . . . . . . . . DisableServices . . . . . . . . . DNS CheckNSStatus . . . . . . GetDNS . . . . . . . . . . . GetDNSStatus . . . . . . . ModifyNS . . . . . . . . . . ModifyNSHosting . . . . . redirect hosting . . . . . . . DNS hosting DeleteHostedDomain . . . ExtendDomainDNS . . . . PurchaseHosting . . . . . . PurchaseServices . . . . . domain management AdvancedDomainSearch CheckNSStatus . . . . . . GetAllDomains . . . . . . . GetDomainCount . . . . . GetDomainExp . . . . . . . GetDomainInfo . . . . . . . GetDomains . . . . . . . . . GetDomainStatus . . . . . GetExpiredDomains . . . . GetExtendInfo . . . . . . . GetHomeDomainList . . . GetPasswordBit . . . . . .
. . . . . . . . 149 . . . . . . . . 211 . . . . . . . . 374 . . . . . . . . 81 . . . . . . . . 86 . . . . . . . . 565 . . . . . . . . 279 . . . . . . . . 442 . . . . . . . . 93 . . . . . . . . 167 . . . . . . . . 81 . . . . . . . . 86 . . . . . . . . 130 . . . . . . . . 141 . . . . . . . . 170 . . . . . . . . 273
. . . . . . . . . . . 89 . . . . . . . . . . . 91 . . . . . . . . . . . 93 . . . . . . . . . . . 95 . . . . . . . . . . . 97 . . . . . . . . . . . 99 . . . . . . . . . . . 102 . . . . . . . . . . . 104 . . . . . . . . . . . 106 . . . . . . . . . . . 109 . . . . . . . . . . . 111 . . . . . . . . . . . 72 . . . . . . . . . . . 173 . . . . . . . . . . . 175 . . . . . . . . . . . 333 . . . . . . . . . . . 336 . . . . . . . . . . . 336 . . . . . . . . . . . 97 . . . . . . . . . . . 123 . . . . . . . . . . . 389 . . . . . . . . . . . 399 . . . . . . . . . . . 31 . . . . . . . . . . . 72 . . . . . . . . . . . 144 . . . . . . . . . . . 177 . . . . . . . . . . . 180 . . . . . . . . . . . 182 . . . . . . . . . . . 189 . . . . . . . . . . . 201 . . . . . . . . . . . 208 . . . . . . . . . . . 215 . . . . . . . . . . . 230 . . . . . . . . . . . 247 586
©2003-2009 Register.com, Inc.
GetRegistrationStatus . . . . . . . . . . GetRegLock . . . . . . . . . . . . . . . . GetRenew . . . . . . . . . . . . . . . . . GetSubAccountPassword . . . . . . . PushDomain . . . . . . . . . . . . . . . . renewals . . . . . . . . . . . . . . . . . . SetPakRenew . . . . . . . . . . . . . . . SetPassword . . . . . . . . . . . . . . . . SetRegLock . . . . . . . . . . . . . . . . SetRenew . . . . . . . . . . . . . . . . . . SubAccountDomains . . . . . . . . . . ValidatePassword . . . . . . . . . . . . domain name IDs GetAllDomains . . . . . . . . . . . . . . GetHomeDomainList . . . . . . . . . . . SubAccountDomains . . . . . . . . . . domain name servers CheckNSStatus . . . . . . . . . . . . . . DeleteHostedDomain . . . . . . . . . . ExtendDomainDNS . . . . . . . . . . . GetDNS . . . . . . . . . . . . . . . . . . . GetDNSStatus . . . . . . . . . . . . . . . ModifyNS . . . . . . . . . . . . . . . . . . ModifyNSHosting . . . . . . . . . . . . . PurchaseHosting . . . . . . . . . . . . . redirect hosting . . . . . . . . . . . . . . domain names AddToCart . . . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . . GetDomainServices . . . . . . . . . . .
3/13/09
Index:
... ... ... ... ... ... ... ... ... ... ... ...
262 264 267 288 408 215 458 460 465 468 486 568
. . . 144 . . . 230 . . . 486 ... ... ... ... ... ... ... ... ...
72 97 123 173 175 333 336 389 336
... ... ... ... ... ... ... ... ... ...
21 66 106 187 196 241 341 345 201 568
... ... ... ... ... ... ... ... ...
282 330 15 66 282 330 380 483 69
... ... ... ... ... ... ...
116 120 180 215 267 468 553
. . . 111 . . . 113 . . . 193
GetDomainSubServices . . . . ServiceSelect . . . . . . . . . . . SetDomainSubServices . . . . 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 . 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_SetPricing . . . . . . . . . . SetResellerTLDPricing . . . . . UpdateAccountPricing . . . . . UpdateExpiredDomains . . . . dynamic IP SetDNSHost . . . . . . . . . . .
. . . . . . . . 204 . . . . . . . . 436 . . . . . . . . 450 . . . . . . . . 408 . . . . . . . . 489 . . . . . . . . 491 . . . . . . . . 494 . . . . . . . . 500 . . . . . . . . 503 . . . . . . . . 507 . . . . . . . . 511 . . . . . . . . 514 . . . . . . . . 517 . . . . . . . . 520 . . . . . . . . 524 . . . . . . . . 527 . . . . . . . . 529 . . . . . . . . 533 . . . . . . . . 562 . . . . . . . . 182 . . . . . . . . 15 . . . . . . . . 31 . . . . . . . . 116 . . . . . . . . 120 . . . . . . . . 288 . . . . . . . . 187 . . . . . . . . 196 . . . . . . . . 333 . . . . . . . . 345 . . . . . . . . 347 . . . . . . . . 350 . . . . . . . . 353 . . . . . . . . 355 . . . . . . . . 358 . . . . . . . . 361 . . . . . . . . 364 . . . . . . . . 370 . . . . . . . . 474 . . . . . . . . 543 . . . . . . . . 553 . . . . . . . . 445
E editing GetGlobalChangeStatus . . . . . GetGlobalChangeStatusDetail . email forwarding Forwarding . . . . . . . . . . . . . GetCatchAll . . . . . . . . . . . . . GetDotNameForwarding . . . . . GetMailHosts . . . . . . . . . . . . GetPOPForwarding . . . . . . . . SetCatchAll . . . . . . . . . . . . . SetDotNameForwarding . . . . . SetPOPForwarding . . . . . . . .
. . . . . . . 224 . . . . . . . 227 . . . . . . . 127 . . . . . . . 152 . . . . . . . 206 . . . . . . . 236 . . . . . . . 256 . . . . . . . 439 . . . . . . . 453 . . . . . . . 462 587
©2003-2009 Register.com, Inc.
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 . . . . . . . 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 . . . . . . . .
F
Forwarding . . . . . . fraud GetFraudScore
G
89 102 104 127 152 206 218 236 249 253 256 309 312 315 318 321 324 327 338 353 393 421 436 439 453 458 462 480 524 113
. . . . . . . . . . . 489 ........... ........... ........... ........... ........... ...........
144 230 486 116 120 123
. . . . . . . . . . . 211 . . . . . . . . . . . 374
. . . . . . . . . . . . . . . . . 127 . . . . . . . . . . . . . . . . . 221
GetAccountInfo . . . . GetAccountPassword GetAccountValidation GetAddressBook . . . GetAllAccountInfo . . GetAllDomains . . . . GetBalance . . . . . . . GetCartContent . . . . GetCatchAll . . . . . .
3/13/09
........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ...........
Index:
................ ................ ................ ................ ................ ................ ................ ................ ................
130 133 135 137 141 144 147 149 152
GetCerts . . . . . . . . . . . . . . . . . . GetConfirmationSettings . . . . . . . . GetContacts . . . . . . . . . . . . . . . . GetCusPreferences . . . . . . . . . . . GetCustomerDefinedData . . . . . . . GetCustomerPaymentInfo . . . . . . . GetDNS . . . . . . . . . . . . . . . . . . GetDNSStatus . . . . . . . . . . . . . . GetDomainCount . . . . . . . . . . . . GetDomainExp . . . . . . . . . . . . . . GetDomainInfo . . . . . . . . . . . . . . GetDomainNameID . . . . . . . . . . . GetDomains . . . . . . . . . . . . . . . . GetDomainServices . . . . . . . . . . . GetDomainSLDTLD . . . . . . . . . . . GetDomainSRVHosts . . . . . . . . . GetDomainStatus . . . . . . . . . . . . GetDomainSubServices . . . . . . . . GetDotNameForwarding . . . . . . . . GetExpiredDomains . . . . . . . . . . . GetExtAttributes . . . . . . . . . . . . . GetExtendInfo . . . . . . . . . . . . . . GetForwarding . . . . . . . . . . . . . . GetFraudScore . . . . . . . . . . . . . . GetGlobalChangeStatus . . . . . . . . GetGlobalChangeStatusDetail . . . . GetHomeDomainList . . . . . . . . . . GetHosts . . . . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . GetWhoisContact . . . . . . . . . . . . GetWPPSInfo . . . . . . . . . . . . . . . global edit GetGlobalChangeStatus . . . . . GetGlobalChangeStatusDetail .
. . . . . . . 154 . . . . . . . 157 . . . . . . . 160 . . . . . . . 164 . . . . . . . 167 . . . . . . . 170 . . . . . . . 173 . . . . . . . 175 . . . . . . . 177 . . . . . . . 180 . . . . . . . 182 . . . . . . . 187 . . . . . . . 189 . . . . . . . 193 . . . . . . . 196 . . . . . . . 198 . . . . . . . 201 . . . . . . . 204 . . . . . . . 206 . . . . . . . 208 . . . . . . . 211 . . . . . . . 215 . . . . . . . 218 . . . . . . . 221 . . . . . . . 224 . . . . . . . 227 . . . . . . . 230 . . . . . . . 233 . . . . . . . 236 . . . . . . . 239 . . . . . . . 241 . . . . . . . 244 . . . . . . . 247 . . . . . . . 249 . . . . . . . 253 . . . . . . . 256 . . . . . . . 259 . . . . . . . 262 . . . . . . . 264 . . . . . . . 267 . . . . . . . 270 . . . . . . . 273 . . . . . . . 279 . . . . . . . 276 . . . . . . . 282 . . . . . . . 288 . . . . . . . 290 . . . . . . . 293 . . . . . . . 75 . . . . . . . 296 . . . . . . . 299 . . . . . . . 303 . . . . . . . 306 . . . . . . . 224 . . . . . . . 227
588
©2003-2009 Register.com, Inc.
H
HE_CancelAccount . . . . . HE_ChangePassword . . . . HE_CreateAccount . . . . . . 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 . . . .
............ ............ ............ ............ ............ ............ ............
Index:
309 312 315 318 321 324 327
. . . . . . . . . . . . 299 . . . . . . . . . . . . 429 ............ ............ ............ ............ ............ ............ ............ ............
198 233 239 259 445 447 455 555
............ ............ ............ ............ ............ ............ ............
309 312 315 318 321 324 327
. . . . . . . . . . . . 97 . . . . . . . . . . . . 123 . . . . . . . . . . . . 389
I identity AddContact . . . . . . Contacts . . . . . . . . DeleteContact . . . . GetAddressBook . . GetContacts . . . . . GetServiceContact . validating . . . . . . . identity protection DisableServices . . . EnableServices . . . GetWPPSInfo . . . . PurchaseServices . RenewServices . . . ServiceSelect . . . . InsertNewOrder . . . . . . IP address update SetDNSHost . . . . . items DeleteFromCart . . . Purchase . . . . . . .
.............. .............. .............. .............. .............. .............. ..............
18 77 91 137 160 279 69
.............. .............. .............. .............. .............. .............. ..............
111 113 306 399 425 436 330
. . . . . . . . . . . . . . 445 . . . . . . . . . . . . . . 95 . . . . . . . . . . . . . . 380
L locking domains GetRegLock
3/13/09
. . . . . . . . . . . . . . . . . . . 264
SetRegLock . login validating . . .
. . . . . . . . . . . . . . . . . . . 465 . . . . . . . . . . . . . . . . . . . 69
M 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 . . . . . . GetDomainExp . . . . . . . . GetDomainInfo . . . . . . . . GetDomains . . . . . . . . . . GetDomainStatus . . . . . . GetExpiredDomains . . . . . GetExtendInfo . . . . . . . . GetHomeDomainList . . . . GetPasswordBit . . . . . . . GetRegistrationStatus . . . GetRegLock . . . . . . . . . . GetRenew . . . . . . . . . . . GetSubAccountPassword . PushDomain . . . . . . . . . renewals . . . . . . . . . . . . SetPakRenew . . . . . . . . SetPassword . . . . . . . . .
. . . . . . . . . . 276 . . . . . . . . . . 477 . . . . . . . . . . 236 . . . . . . . . . . 89 . . . . . . . . . . 102 . . . . . . . . . . 104 . . . . . . . . . . 127 . . . . . . . . . . 152 . . . . . . . . . . 206 . . . . . . . . . . 218 . . . . . . . . . . 249 . . . . . . . . . . 253 . . . . . . . . . . 256 . . . . . . . . . . 309 . . . . . . . . . . 312 . . . . . . . . . . 315 . . . . . . . . . . 318 . . . . . . . . . . 321 . . . . . . . . . . 324 . . . . . . . . . . 327 . . . . . . . . . . 338 . . . . . . . . . . 353 . . . . . . . . . . 393 . . . . . . . . . . 421 . . . . . . . . . . 439 . . . . . . . . . . 453 . . . . . . . . . . 458 . . . . . . . . . . 462 . . . . . . . . . . 480 . . . . . . . . . . 249 . . . . . . . . . . 72 . . . . . . . . . . 144 . . . . . . . . . . 177 . . . . . . . . . . 180 . . . . . . . . . . 182 . . . . . . . . . . 189 . . . . . . . . . . 201 . . . . . . . . . . 208 . . . . . . . . . . 215 . . . . . . . . . . 230 . . . . . . . . . . 247 . . . . . . . . . . 262 . . . . . . . . . . 264 . . . . . . . . . . 267 . . . . . . . . . . 288 . . . . . . . . . . 408 . . . . . . . . . . 215 . . . . . . . . . . 458 . . . . . . . . . . 460 589
©2003-2009 Register.com, Inc.
SetRegLock . . . . . . SetRenew . . . . . . . . SubAccountDomains ValidatePassword . . metatags GetMetaTag . . . . . . UpdateMetaTag . . . . ModifyNS . . . . . . . . . . . ModifyNSHosting . . . . . . ModifyPOP3 . . . . . . . . . multiple domains adding . . . . . . . . . .
Index:
............. ............. ............. .............
465 468 486 568
............. ............. ............. ............. .............
239 555 333 336 338
. . . . . . . . . . . . . 15
N name servers CheckNSStatus . . . . . . DeleteHostedDomain . . DeleteNameserver . . . . ExtendDomainDNS . . . GetCusPreferences . . . GetDNS . . . . . . . . . . . GetDNSStatus . . . . . . . ModifyNS . . . . . . . . . . ModifyNSHosting . . . . . PurchaseHosting . . . . . redirect hosting . . . . . . RegisterNameServer. . . UpdateCusPreferences . UpdateNameServer . . . names checking availability . . . ParseDomain . . . . . . . NameSpinner . . . . . . . . . .
........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ...........
72 97 99 123 164 173 175 333 336 389 336 415 549 558
. . . . . . . . . . . 66 . . . . . . . . . . . 345 . . . . . . . . . . . 341
O orders cancelling transfer orders . . . . . . 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 . . . . . . .
..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... .....
491 494 157 241 244 330 503 527 201 500 500 517 529 514 533
............ ............ ............ ............ ............
570 575 579 582 345
P packages WSC_GetAccountInfo . WSC_GetAllPackages WSC_GetPricing . . . . WSC_Update_Ops . . . ParseDomain . . . . . . . . .
3/13/09
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_SetPricing . . . . . . . . . . . . POP mail DeleteAllPOPPaks . . . . . . DeletePOP3 . . . . . . . . . . . DeletePOPPak . . . . . . . . . GetCatchAll . . . . . . . . . . . GetMailHosts . . . . . . . . . . GetPOP3 . . . . . . . . . . . . . GetPOPExpirations . . . . . . GetPOPForwarding . . . . . . ModifyPOP3 . . . . . . . . . . . PurchasePOPBundle . . . . . PurchaseServices . . . . . . . RenewPOPBundle . . . . . . SetCatchAll . . . . . . . . . . . SetPakRenew . . . . . . . . . SetPOPForwarding . . . . . . SetUpPOP3User . . . . . . . . Preconfigure . . . . . . . . . . . . . preconfigure GetExtAttributes . . . . . . . . pricing AuthorizeTLD . . . . . . . . . . GetSubAccountDetails . . . . GetTLDList . . . . . . . . . . . HE_GetPricing . . . . . . . . . PE_GetCustomerPricing . . . PE_GetDomainPricing . . . . PE_GetPOPPrice . . . . . . . PE_GetProductPrice . . . . . PE_GetResellerPrice . . . . . PE_GetRetailPrice . . . . . . PE_GetRetailPricing . . . . . PE_SetPricing . . . . . . . . . RemoveTLD . . . . . . . . . . . SetResellerServicesPricing . SetResellerTLDPricing . . . . UpdateAccountPricing . . . . WSC_GetAccountInfo . . . . WSC_GetAllPackages . . . . WSC_GetPricing . . . . . . . . WSC_Update_Ops . . . . . . privacy protection
. . . . . . . . . 288 . . . . . . . . . 133 . . . . . . . . . 135 . . . . . . . . . 247 . . . . . . . . . 338 . . . . . . . . . 434 . . . . . . . . . 460 . . . . . . . . . 568 . . . . . . . . . 347 . . . . . . . . . 350 . . . . . . . . . 353 . . . . . . . . . 355 . . . . . . . . . 358 . . . . . . . . . 361 . . . . . . . . . 364 . . . . . . . . . 370 . . . . . . . . . 89 . . . . . . . . . 102 . . . . . . . . . 104 . . . . . . . . . 152 . . . . . . . . . 236 . . . . . . . . . 249 . . . . . . . . . 253 . . . . . . . . . 256 . . . . . . . . . 338 . . . . . . . . . 393 . . . . . . . . . 399 . . . . . . . . . 421 . . . . . . . . . 439 . . . . . . . . . 458 . . . . . . . . . 462 . . . . . . . . . 480 . . . . . . . . . 374 . . . . . . . . . 211 . . . . . . . . . 37 . . . . . . . . . 282 . . . . . . . . . 296 . . . . . . . . . 324 . . . . . . . . . 347 . . . . . . . . . 350 . . . . . . . . . 353 . . . . . . . . . 355 . . . . . . . . . 358 . . . . . . . . . 361 . . . . . . . . . 364 . . . . . . . . . 370 . . . . . . . . . 418 . . . . . . . . . 471 . . . . . . . . . 474 . . . . . . . . . 543 . . . . . . . . . 570 . . . . . . . . . 575 . . . . . . . . . 579 . . . . . . . . . 582
590
©2003-2009 Register.com, Inc.
DisableServices . . . . . . . . EnableServices . . . . . . . . GetWPPSInfo . . . . . . . . . PurchaseServices . . . . . . RenewServices . . . . . . . . ServiceSelect . . . . . . . . . products PE_GetCustomerPricing . . PE_GetPOPPrice . . . . . . . PE_GetProductPrice . . . . . PE_GetResellerPrice . . . . PE_GetRetailPrice . . . . . . PE_GetRetailPricing . . . . . PE_SetPricing . . . . . . . . . SetResellerServicesPricing SetResellerTLDPricing . . . UpdateAccountPricing . . . . Purchase . . . . . . . . . . . . . . . purchase AddBulkDomains . . . . . . . PurchaseHosting . . . . . . . . . . PurchasePOPBundle . . . . . . . PurchasePreview . . . . . . . . . . PurchaseServices . . . . . . . . . purchasing DeleteFromCart . . . . . . . . InsertNewOrder . . . . . . . . PE_GetPOPPrice . . . . . . . UpdateCart . . . . . . . . . . . PushDomain . . . . . . . . . . . . . pushing domains UpdatePushList . . . . . . . .
Index:
......... ......... ......... ......... ......... .........
111 113 306 399 425 436
......... ......... ......... ......... ......... ......... ......... ......... ......... ......... .........
347 353 355 358 361 364 370 471 474 543 380
......... ......... ......... ......... .........
15 389 393 396 399
......... ......... ......... ......... .........
95 330 353 547 408
. . . . . . . . . 562
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 . . . . .
3/13/09
........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ...........
116 120 123 315 327 380 389 393 399 421 425 494 527 529 553 411
. . . . . . . . . . . 483 . . . . . . . . . . . 415 ........... ........... ........... ...........
18 77 91 137
GetContacts . . . . . . . . . . . . . . . . . . . GetWhoisContact . . . . . . . . . . . . . . . SyncAuthInfo . . . . . . . . . . . . . . . . . . registrar lock GetCusPreferences . . . . . . . . . . . . . . GetRegLock . . . . . . . . . . . . . . . . . . . SetRegLock . . . . . . . . . . . . . . . . . . . UpdateCusPreferences . . . . . . . . . . . registration Extend . . . . . . . . . . . . . . . . . . . . . . Extend_RGP . . . . . . . . . . . . . . . . . . GetRegistrationStatus . . . . . . . . . . . . GetSubAccountDetails . . . . . . . . . . . . InsertNewOrder . . . . . . . . . . . . . . . . UpdateExpiredDomains . . . . . . . . . . . validating user ID . . . . . . . . . . . . . . . Registry GetExtAttributes . . . . . . . . . . . . . . . . ModifyNS . . . . . . . . . . . . . . . . . . . . RemoveTLD . . . . . . . . . . . . . . . . . . . . . . renewals Extend . . . . . . . . . . . . . . . . . . . . . . Extend_RGP . . . . . . . . . . . . . . . . . . GetDomainExp . . . . . . . . . . . . . . . . . GetExtendInfo . . . . . . . . . . . . . . . . . GetRenew . . . . . . . . . . . . . . . . . . . . SetPakRenew . . . . . . . . . . . . . . . . . SetRenew . . . . . . . . . . . . . . . . . . . . UpdateExpiredDomains . . . . . . . . . . . RenewPOPBundle . . . . . . . . . . . . . . . . . RenewServices . . . . . . . . . . . . . . . . . . . . reporting GetOrderDetail . . . . . . . . . . . . . . . . . GetOrderList . . . . . . . . . . . . . . . . . . GetReport . . . . . . . . . . . . . . . . . . . . GetTransHistory . . . . . . . . . . . . . . . . RPT_GetReport . . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . . . . . .
. 160 . 303 . 489 . 164 . 264 . 465 . 549 . 116 . 120 . 262 . 282 . 330 . 553 . 69 . 211 . 333 . 418 . 116 . 120 . 180 . 215 . 267 . 458 . 468 . 553 . 421 . 425 . 241 . 244 . 270 . 299 . 429 . 130 . 157 . 170 . 273 . 282 . 358 . 503 . 507 . 511 . 500 . 517 . 514 . 429 . 483
S search engines GetMetaTag . . . UpdateMetaTag
. . . . . . . . . . . . . . . . . 239 . . . . . . . . . . . . . . . . . 555 591
©2003-2009 Register.com, Inc.
searching AdvancedDomainSearch . security CertConfigureCert . . . . . CertGetApproverEmail . . CertGetCertDetail . . . . . . CertGetCerts item list . . . CertModifyCert . . . . . . . CertParseCSR . . . . . . . . CertPurchaseCert . . . . . 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 . . . . . . . GetDomainServices . . . . GetDomainSubServices. . GetDotNameForwarding . GetExpiredDomains . . . . GetForwarding . . . . . . . . GetMailHosts . . . . . . . . GetPOP3 . . . . . . . . . . . GetPOPExpirations . . . . GetPOPForwarding . . . . GetWPPSInfo . . . . . . . . ModifyPOP3 passwords. . PE_GetCustomerPricing . PE_GetPOPPrice . . . . . . PE_GetProductPrice . . . . PE_GetResellerPrice . . . PE_GetRetailPrice . . . . . PE_GetRetailPricing . . . . PE_SetPricing . . . . . . . . PurchasePOPBundle . . . PurchaseServices . . . . . RenewPOPBundle . . . . .
3/13/09
Index:
. . . . . . . . . . 31 .......... .......... .......... .......... .......... .......... .......... .......... .......... ..........
40 47 50 54 57 60 63 154 399 434
. . . . . . . . . . 276 . . . . . . . . . . 477 .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... ..........
97 99 123 173 175 333 336 389 336 415 558
.......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... ..........
21 102 89 104 111 127 113 152 182 193 204 206 208 218 236 249 253 256 306 338 347 353 355 358 361 364 370 393 399 421
RenewServices . . . . . . . . . ServiceSelect . . . . . . . . . . SetCatchAll . . . . . . . . . . . SetDomainSubServices . . . SetDotNameForwarding . . . SetPakRenew . . . . . . . . . SetPOPForwarding . . . . . . SetResellerServicesPricing . SetUpPOP3User . . . . . . . . UpdateAccountPricing . . . . ServiceSelect . . . . . . . . . . . . . SetCatchAll . . . . . . . . . . . . . . SetCustomerDefinedData . . . . . SetDNSHost . . . . . . . . . . . . . SetDomainSRVHosts . . . . . . . . SetDomainSubServices . . . . . . SetDotNameForwarding . . . . . . SetHosts . . . . . . . . . . . . . . . . SetPakRenew . . . . . . . . . . . . SetPassword . . . . . . . . . . . . . SetPOPForwarding . . . . . . . . . SetRegLock . . . . . . . . . . . . . . SetRenew . . . . . . . . . . . . . . . SetResellerServicesPricing . . . . SetResellerTLDPricing . . . . . . . SetSPFHosts . . . . . . . . . . . . . SetUpPOP3User . . . . . . . . . . . shopping cart AddBulkDomains . . . . . . . AddToCart . . . . . . . . . . . . DeleteFromCart . . . . . . . . GetCartContent . . . . . . . . InsertNewOrder . . . . . . . . Purchase . . . . . . . . . . . . . PurchasePreview . . . . . . . UpdateCart . . . . . . . . . . . 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 . . . . . . StatusDomain . . . . . . . . . . . . . SubAccountDomains . . . . . . . . subaccounts
. . . . . . . . . 425 . . . . . . . . . 436 . . . . . . . . . 439 . . . . . . . . . 450 . . . . . . . . . 453 . . . . . . . . . 458 . . . . . . . . . 462 . . . . . . . . . 471 . . . . . . . . . 480 . . . . . . . . . 543 . . . . . . . . . 436 . . . . . . . . . 439 . . . . . . . . . 442 . . . . . . . . . 445 . . . . . . . . . 447 . . . . . . . . . 450 . . . . . . . . . 453 . . . . . . . . . 455 . . . . . . . . . 458 . . . . . . . . . 460 . . . . . . . . . 462 . . . . . . . . . 465 . . . . . . . . . 468 . . . . . . . . . 471 . . . . . . . . . 474 . . . . . . . . . 477 . . . . . . . . . 480 . . . . . . . . . 15 . . . . . . . . . 21 . . . . . . . . . 95 . . . . . . . . . 149 . . . . . . . . . 330 . . . . . . . . . 380 . . . . . . . . . 396 . . . . . . . . . 547 . . . . . . . . . 276 . . . . . . . . . 477 . . . . . . . . . 198 . . . . . . . . . 447 . . . . . . . . . 40 . . . . . . . . . 47 . . . . . . . . . 50 . . . . . . . . . 54 . . . . . . . . . 57 . . . . . . . . . 60 . . . . . . . . . 63 . . . . . . . . . 154 . . . . . . . . . 399 . . . . . . . . . 72 . . . . . . . . . 182 . . . . . . . . . 208 . . . . . . . . . 483 . . . . . . . . . 486
592
©2003-2009 Register.com, Inc.
creating . . . . . . . . . . . . DeleteSubaccount . . . . . get domain list . . . . . . . . GetAccountPassword . . . GetAccountValidation . . . GetConfirmationSettings . GetSubAccountDetails . . GetSubAccounts . . . . . . GetSubAccountsDetailList SendAccountEmail . . . . . support GetServiceContact . . . . . SynchAuthInfo . . . . . . . . . . .
.......... .......... .......... .......... .......... .......... .......... .......... .......... ..........
Index:
86 109 189 133 135 157 282 290 293 434
. . . . . . . . . . 279 . . . . . . . . . . 489
T technical support GetServiceContact . . . . . 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 . . . . . . . TP_ResendEmail . . . . . . TP_ResubmitLocked . . . . TP_SubmitOrder . . . . . . TP_UpdateOrderDetail . . UpdatePushList . . . . . . .
U
UpdateAccountInfo .
3/13/09
. . . . . . . . . . 279 .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... ..........
37 211 296 418 491 494 500 503 507 511 514 517 520 524 527 529 533
. . . . . . . . . . 299 . . . . . . . . . . 429 .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... ..........
160 408 489 491 494 500 503 507 511 514 517 520 524 527 529 533 562
. . . . . . . . . . . . . . . . . 538
UpdateAccountPricing . . . . . . . . UpdateCart . . . . . . . . . . . . . . . UpdateCusPreferences . . . . . . . UpdateExpiredDomains . . . . . . . UpdateMetaTag . . . . . . . . . . . . UpdateNameServer . . . . . . . . . . UpdateNotificationAmount . . . . . . UpdatePushList . . . . . . . . . . . . UpdateRenewalSettings . . . . . . . user ID validating . . . . . . . . . . . . . . user-defined data DeleteCustomerDefinedData . GetCustomerDefinedData . . . SetCustomerDefinedData . . . users CreateAccount . . . . . . . . . . CreateSubAccount . . . . . . . GetAccountInfo . . . . . . . . . . GetAllAccountInfo . . . . . . . . GetCustomerPaymentInfo . . . GetResellerInfo . . . . . . . . . .
V
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 . . . . . . . . . ServiceSelect . . . . . . . . . . SetDomainSubServices . . . SetPakRenew . . . . . . . . . SetResellerServicesPricing . UpdateAccountPricing . . . .
. . . . . . . . 543 . . . . . . . . 547 . . . . . . . . 549 . . . . . . . . 553 . . . . . . . . 555 . . . . . . . . 558 . . . . . . . . 560 . . . . . . . . 562 . . . . . . . . 565 . . . . . . . . 69 . . . . . . . . 93 . . . . . . . . 167 . . . . . . . . 442 . . . . . . . . 81 . . . . . . . . 86 . . . . . . . . 130 . . . . . . . . 141 . . . . . . . . 170 . . . . . . . . 273
. . . . . . . . . 568 . . . . . . . . . 69 . . . . . . . . . 21 . . . . . . . . . 89 . . . . . . . . . 102 . . . . . . . . . 104 . . . . . . . . . 111 . . . . . . . . . 127 . . . . . . . . . 113 . . . . . . . . . 120 . . . . . . . . . 182 . . . . . . . . . 193 . . . . . . . . . 204 . . . . . . . . . 208 . . . . . . . . . 236 . . . . . . . . . 347 . . . . . . . . . 355 . . . . . . . . . 358 . . . . . . . . . 361 . . . . . . . . . 364 . . . . . . . . . 370 . . . . . . . . . 393 . . . . . . . . . 399 . . . . . . . . . 425 . . . . . . . . . 436 . . . . . . . . . 450 . . . . . . . . . 458 . . . . . . . . . 471 . . . . . . . . . 543
W Web hosting packages WSC_GetAccountInfo
. . . . . . . . . . . . . 570
593
©2003-2009 Register.com, Inc.
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 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 . . . . . .
3/13/09
Index:
. . . . . . . . . . . . 575 . . . . . . . . . . . . 579 . . . . . . . . . . . . 582 . . . . . . . . . . . . 436 ............ ............ ............ ............
570 575 579 582
. . . . . . . . . . . . 160 . . . . . . . . . . . . 303 . . . . . . . . . . . . 18 . . . . . . . . . . . . 91 . . . . . . . . . . . . 137 ............ ............ ............ ............ ............
111 113 306 425 436
. . . . . . . . . . . . 399 ............ ............ ............ ............ ............ ............ ............ ............
570 575 579 582 570 575 579 582
594
