API Commands: For Resellers of Domain Names and Related Services
API Commands: For Resellers of Domain Names and Related Services
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.
3/13/09 2
©2003-2009 Register.com, Inc.
Contents
API command categories . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
API commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
AddBulkDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
AddContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
AddToCart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
AdvancedDomainSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
AuthorizeTLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
CertConfigureCert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
CertGetApproverEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
CertGetCertDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
CertGetCerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
CertModifyOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
CertParseCSR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
CertPurchaseCert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
CheckLogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
CheckNSStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
CommissionAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
CreateAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
CreateSubAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
DeleteAllPOPPaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
DeleteContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
DeleteCustomerDefinedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
DeleteFromCart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
DeleteHostedDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
DeleteNameServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
DeletePOP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
DeletePOPPak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
DeleteRegistration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
DeleteSubaccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
DisableServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
EnableServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Extend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
3/13/09 3
©2003-2009 Register.com, Inc. :
Extend_RGP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
ExtendDomainDNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
GetAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
GetAccountPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
GetAccountValidation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
GetAddressBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
GetAllAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
GetAllDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
GetBalance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
GetCartContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
GetCatchAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
GetCerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
GetConfirmationSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
GetContacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
GetCusPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
GetCustomerDefinedData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
GetCustomerPaymentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
GetDNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
GetDNSStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
GetDomainCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
GetDomainExp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
GetDomainInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
GetDomainNameID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
GetDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
GetDomainServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
GetDomainSLDTLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
GetDomainSRVHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
GetDomainStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
GetDomainSubServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
GetDotNameForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
GetExpiredDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
GetExtAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
GetExtendInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
GetForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
GetFraudScore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
GetGlobalChangeStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
GetGlobalChangeStatusDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
GetHomeDomainList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
GetHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
GetMailHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
GetMetaTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
GetOrderDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
GetOrderList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
GetPasswordBit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
GetPOP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
GetPOPExpirations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
GetPOPForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
GetRegHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
GetRegistrationStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
GetRegLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
GetRenew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
GetReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
GetResellerInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
3/13/09 4
©2003-2009 Register.com, Inc. :
GetSPFHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
GetServiceContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
GetSubAccountDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
GetSubAccountPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
GetSubAccounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
GetSubaccountsDetailList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
GetTLDList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
GetTransHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
GetWhoisContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
GetWPPSInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
HE_CancelAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
HE_ChangePassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
HE_CreateAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
HE_GetAccountDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
HE_GetAccounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
HE_GetPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
HE_UpgradeAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
InsertNewOrder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
ModifyNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
ModifyNSHosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
ModifyPOP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
NameSpinner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
ParseDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
PE_GetCustomerPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
PE_GetDomainPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
PE_GetPOPPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
PE_GetProductPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
PE_GetResellerPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
PE_GetRetailPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
PE_GetRetailPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
PE_GetTLDID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
PE_SetPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Preconfigure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Purchase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
PurchaseHosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
PurchasePOPBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
PurchasePreview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
PurchaseServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
PushDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
RefillAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
RegisterNameServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
RemoveTLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
RenewPOPBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
RenewServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
RPT_GetReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
SendAccountEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
ServiceSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
SetCatchAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
SetCustomerDefinedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
SetDNSHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
SetDomainSRVHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
SetDomainSubServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
SetDotNameForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
SetHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
3/13/09 5
©2003-2009 Register.com, Inc. :
SetPakRenew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
SetPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
SetPOPForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
SetRegLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
SetRenew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
SetResellerServicesPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
SetResellerTLDPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
SetSPFHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
SetUpPOP3User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
StatusDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
SubAccountDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
SynchAuthInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
TP_CancelOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
TP_CreateOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
TP_GetDetailsByDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
TP_GetOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
TP_GetOrderDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
TP_GetOrderReview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
TP_GetOrdersByDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
TP_GetOrderStatuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
TP_GetTLDInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
TP_ResendEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
TP_ResubmitLocked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
TP_SubmitOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
TP_UpdateOrderDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
UpdateAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
UpdateAccountPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
UpdateCart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
UpdateCusPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
UpdateExpiredDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
UpdateMetaTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
UpdateNameServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
UpdateNotificationAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
UpdatePushList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
UpdateRenewalSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
ValidatePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
WSC_GetAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
WSC_GetAllPackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
WSC_GetPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
WSC_Update_Ops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
3/13/09 6
©2003-2009 Register.com, Inc. API command categories
3/13/09 7
©2003-2009 Register.com, Inc. API command categories:
3/13/09 8
©2003-2009 Register.com, Inc. API command categories:
Domain services
DisableServices
EnableServices
GetDomainServices
PurchaseServices
RenewServices
ServiceSelect
3/13/09 9
©2003-2009 Register.com, Inc. API command categories:
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:
Reporting commands
DeleteCustomerDefinedData
GetCustomerDefinedData
GetOrderDetail
GetOrderList
GetReport
GetTLDList
GetTransHistory
RPT_GetReport
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:
3/13/09 13
©2003-2009 Register.com, Inc. API commands:
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
3/13/09 15
©2003-2009 Register.com, Inc. API commands: AddBulkDomains
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<AddBulkDomains>
<Item>
<ItemName>partnerdomain.com</ItemName>
<ItemId />
<Price>29.95</Price>
<ItemAdded>True</ItemAdded>
</Item>
<Item>
<ItemName>partnerdomain2.net</ItemName>
<ItemId />
<Price>29.95</Price>
3/13/09 16
©2003-2009 Register.com, Inc. API commands: AddBulkDomains
<ItemAdded>True</ItemAdded>
</Item>
<Item>
<ItemName>partnerdomain3.info</ItemName>
<ItemId />
<Price>29.95</Price>
<ItemAdded>True</ItemAdded>
</Item>
<AllItemsSuccessful>True</AllItemsSuccessful>
</AddBulkDomains>
<Command>ADDBULKDOMAINS</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 18
©2003-2009 Register.com, Inc. API commands: AddContact
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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&[email protected]&
responsetype=xml
In the response, a Party ID and an ErrCount value of 0 confirm that the query was successful:
<?xml version="1.0" ?>
<interface-response>
<Contact>
<RegistrantPartyID>{FFD61956-8D43-45FB-BC38-E0EE23331503}</RegistrantPartyID>
</Contact>
<Command>ADDCONTACT</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
3/13/09 19
©2003-2009 Register.com, Inc. API commands: AddContact
<Site>e</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.3164063</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
Contacts
GetAddressBook
GetContacts
GetExtAttributes
GetResellerInfo
GetServiceContact
GetWhoisContact
Preconfigure
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
3/13/09 21
©2003-2009 Register.com, Inc. API commands: AddToCart
3/13/09 22
©2003-2009 Register.com, Inc. API commands: AddToCart
3/13/09 23
©2003-2009 Register.com, Inc. API commands: AddToCart
3/13/09 24
©2003-2009 Register.com, Inc. API commands: AddToCart
3/13/09 25
©2003-2009 Register.com, Inc. API commands: AddToCart
3/13/09 26
©2003-2009 Register.com, Inc. API commands: AddToCart
3/13/09 27
©2003-2009 Register.com, Inc. API commands: AddToCart
3/13/09 28
©2003-2009 Register.com, Inc. API commands: AddToCart
3/13/09 29
©2003-2009 Register.com, Inc. API commands: AddToCart
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<ItemName>partnerdomain.com</ItemName>
<ItemId />
<Price>29.95</Price>
<ItemAdded>True</ItemAdded>
<Command>ADDTOCART</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 31
©2003-2009 Register.com, Inc. API commands: AdvancedDomainSearch
3/13/09 32
©2003-2009 Register.com, Inc. API commands: AdvancedDomainSearch
3/13/09 33
©2003-2009 Register.com, Inc. API commands: AdvancedDomainSearch
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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
3/13/09 35
©2003-2009 Register.com, Inc. API commands: AdvancedDomainSearch
<Domain>
<DomainNameID>152533676</DomainNameID>
<SLD>partnerdomain</SLD>
<TLD>com</TLD>
<AutoRenew>1</AutoRenew>
<ExpDate>6/10/2014</ExpDate>
<DomainRegistrationStatus>Registered</DomainRegistrationStatus>
<DeleteType />
<LoginID>rcompartnerid</LoginID>
<AccountID>217-no-0647</AccountID>
<NSStatus>NA</NSStatus>
<RRProcessor>E</RRProcessor>
<RRCompanyName>Register.com, Inc.</RRCompanyName>
<HasRCOMShield>disabled</HasRCOMShield>
</Domain>
</Domains>
</DomainSearch>
<Command>ADVANCEDDOMAINSEARCH</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.438</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
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
3/13/09 37
©2003-2009 Register.com, Inc. API commands: AuthorizeTLD
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<tldlist>
<authorizetld>com</authorizetld>
<authorizetld>net</authorizetld>
<authorizetld>org</authorizetld>
</tldlist>
<Command>AUTHORIZETLD</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site />
<IsLockable />
<IsRealTimeTLD />
<ExecTime>0.1523438</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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 Purchase the cert in our system
InsertNewOrder
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:
• The login ID and password must be valid.
• The cert must belong to this account.
3/13/09 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
3/13/09 41
©2003-2009 Register.com, Inc. API commands: CertConfigureCert
3/13/09 42
©2003-2009 Register.com, Inc. API commands: CertConfigureCert
3/13/09 43
©2003-2009 Register.com, Inc. API commands: CertConfigureCert
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
ne=5555555555&[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&BillingEmailAd-
[email protected]
In the response, a success value True confirms that the query was successful:
<?xml version="1.0" ?>
<interface-response>
<CertConfigureCert>
<CertID>289</CertID>
<CSRData>
<Success>True</Success>
<Organization>Acme</Organization>
<DomainName>partnerdomain.com</DomainName>
<Email />
<HasBadExtensions>false</HasBadExtensions>
<IsValidQuickDomainName>true</IsValidQuickDomainName>
<IsValidTrueDomainName>true</IsValidTrueDomainName>
<Locality>Townsville</Locality>
<OrganizationUnit>Sales</OrganizationUnit>
<State>NY</State>
<Country>US</Country>
</CSRData>
<ApproverEmail />
<Success>True</Success>
<Approver Type="Domain">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
<Approver Type="Domain">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
<Approver Type="Generic">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
.
.
.
</CertConfigureCert>
<Command>CERTCONFIGURECERT</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>LOCALHOST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>1.328125</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
3/13/09 45
©2003-2009 Register.com, Inc. API commands: CertConfigureCert
</debug>
</interface-response>
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 Purchase the cert in our system
InsertNewOrder
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
3/13/09 47
©2003-2009 Register.com, Inc. API commands: CertGetApproverEmail
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<CertGetApproverEMail>
<Success>True</Success>
<Approver Type="Domain">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
<Approver Type="Generic">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
<Approver Type="Generic">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
<Approver Type="Generic">
<ApproverEmail>[email protected]</ApproverEmail>
3/13/09 48
©2003-2009 Register.com, Inc. API commands: CertGetApproverEmail
</Approver>
<Approver Type="Generic">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
<Approver Type="Generic">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
<Approver Type="Generic">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
<Approver Type="Generic">
<ApproverEmail>[email protected]</ApproverEmail>
</Approver>
<Approver Type="Manual" />
</CertGetApproverEMail>
<Command>CERTGETAPPROVEREMAIL</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>LOCALHOST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.75</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
CertConfigureCert
CertGetCertDetail
CertGetCerts
CertModifyOrder
CertParseCSR
CertPurchaseCert
GetCerts
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
3/13/09 50
©2003-2009 Register.com, Inc. API commands: CertGetCertDetail
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter
Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
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:
<?xml version="1.0" ?>
<interface-response>
<CertGetCertDetail>
<CertID>288</CertID>
<DomainName>partnerdomain.com</DomainName>
<ValidityPeriod>12</ValidityPeriod>
<OrderDate>2/14/2005 11:23:59 AM</OrderDate>
<ConfigDate />
<RenewalIndicator>False</RenewalIndicator>
<WebServerTypeID>13</WebServerTypeID>
<WebServerTypeName>Microsoft IIS 5.0</WebServerTypeName>
<OrderID>156249495</OrderID>
<OrderDetailID>1372870</OrderDetailID>
<ExpirationDate>2/14/2006 11:23:59 AM</ExpirationDate>
<ServerCount>1</ServerCount>
<ApproverEmail>[email protected]</ApproverEmail>
<Message />
<CertStatusID>2</CertStatusID>
<CertStatus>Processing</CertStatus>
<ProdType>21</ProdType>
<ProdDesc>SSL Certificate - GeoTrust True BusinessID</ProdDesc>
<CSR>-----BEGIN NEW CERTIFICATE REQUEST-----
MIIDPjCCAqcCAQAwYzEYMBYGA1UEAxMPa2ltYmVybHlzaGluLnVzMQwwCgY
DVQQLEwNLaW0xDDAKBgNVBAoTA0tpbTERMA8GA1UEBxMIQmVsbGV2dWUxCzA
JBgNVBAgTAldBMQswCQYDVQQGEwJVUzCBnzANBgkqhkiG9w0BAQEFAAOBjQAw
.
.
.
4BP8JmX8T2CJPnHOf2PIeXUujLhzv5bajXv HVTy1oG+/YLc+3LQzSm9rQXjMEk/1e
JXi3OAShQX+S2GbyaUitu+lZ/K8QIzxCto Kf0vNlzbB70fOjWWQqfJhVsm
-----END NEW CERTIFICATE REQUEST-----</CSR>
<ReferenceID>17554</ReferenceID>
<SSLCertificate>>-----BEGIN CERTIFICATE-----
MIIDRTCCAq6gAwIBAgIDBPEKMA0GCSqGSIb3DQEBBAUAMFoxCzAJBgNVBAYTAlVT
MRwwGgYDVQQKExNFcXVpZmF4IFNlY3VyZSBJbmMuMS0wKwYDVQQDEyRFcXVpZm
F4IFNlY3VyZSBHbG9iYWwgZUJ1c2luZXNzIENBLTEwHhcNMDYxMTEzMjIxNDA4WhcN
.
.
.
uJeFstXuC8vlHNiDbfiuVB3avYCKOChvRBcrZmiS907yPjIUbaJ0GtCXkp+uLyje
Y29RJJlU0XN527CE5P3Vh6Oaok5J6cr2tJMwAJS+t9obF8yDR9NHSU+9wcz5nS6V
zRpH7lZ2TDtq6+NT7EA3m5D3vvMI9ESDpw== -----END CERTIFICATE-----
</SSLCertificate>
<AdminOrgName>Partner Domains Inc.</AdminOrgName>
<AdminJobTitle>Tester</AdminJobTitle>
<AdminFName>John</AdminFName>
<AdminLName>Doe</AdminLName>
<AdminAddress1>100 Main Street</AdminAddress1>
<AdminAddress2 />
<AdminCity>Hometown</AdminCity>
<AdminStateProvince />
<AdminStateProvinceChoice />
<AdminPostalCode>99999</AdminPostalCode>
3/13/09 52
©2003-2009 Register.com, Inc. API commands: CertGetCertDetail
<AdminCountry>US</AdminCountry>
<AdminPhone>5559995555</AdminPhone>
<AdminFax>none</AdminFax>
<AdminEmailAddress>[email protected]</AdminEmailAddress>
<AdminPhoneExt />
<TechOrgName>Partner Domains Inc.</TechOrgName>
.
.
.
<BillingOrgName>Partner Domains Inc.</BillingOrgName>
.
.
.
<WebServerTypes>
<WebServerType>
<WebServerTypeID>1</WebServerTypeID>
<WebServerTypeName>Apache + MOD SSL</WebServerTypeName>
<WebServerTypeCode>apachessl</WebServerTypeCode>
</WebServerType>
<WebServerType>
<WebServerTypeID>20</WebServerTypeID>
<WebServerTypeName>Apache + OpenSSL</WebServerTypeName>
<WebServerTypeCode>apacheopenssl</WebServerTypeCode>
</WebServerType>
<WebServerType>
<WebServerTypeID>2</WebServerTypeID>
<WebServerTypeName>Apache + Raven</WebServerTypeName>
<WebServerTypeCode>apacheraven</WebServerTypeCode>
</WebServerType>
.
.
.
</WebServerTypes>
</CertGetCertDetail>
<Command>CERTGETCERTDETAIL</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>LOCALHOST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.1914063</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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 Purchase the cert in our system
InsertNewOrder
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 issu-
ance 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
3/13/09 54
©2003-2009 Register.com, Inc. API commands: CertGetCerts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<CertGetCerts>
<Certs>
<Cert>
<IsExpired>False</IsExpired>
<CertID>233</CertID>
<OrderDate>3/21/2007</OrderDate>
<ConfigDate />
<DomainName />
<ValidityPeriod>12</ValidityPeriod>
<RenewalIndicator>False</RenewalIndicator>
<ProdType>26</ProdType>
3/13/09 55
©2003-2009 Register.com, Inc. API commands: CertGetCerts
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 Purchase the cert in our system
InsertNewOrder
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:
• 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.
3/13/09 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
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<CertModifyOrder>
<CertID>294</CertID>
</CertModifyOrder>
<Command>CERTMODIFYORDER</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
3/13/09 58
©2003-2009 Register.com, Inc. API commands: CertModifyOrder
<Server>LOCALHOST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.109375</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
CertConfigureCert
CertGetApproverEmail
CertGetCertDetail
CertGetCerts
CertParseCSR
CertPurchaseCert
GetCerts
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 Purchase the cert in our system
InsertNewOrder
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
3/13/09 60
©2003-2009 Register.com, Inc. API commands: CertParseCSR
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<CertParseCSR>
<Success>True</Success>
<Organization>Acme Inc.</Organization>
<DomainName>www.partnerdomain.com</DomainName>
<Email />
<Locality>Wilmington</Locality>
<OrganizationUnit>SSL Certificate</OrganizationUnit>
<State>DE</State>
<Country>US</Country>
</CertParseCSR>
<Command>CERTPARSECSR</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>LOCALHOST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.578125</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
CertConfigureCert
CertGetApproverEmail
CertGetCertDetail
CertGetCerts
CertModifyOrder
CertPurchaseCert
GetCerts
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 Purchase the cert in our system
InsertNewOrder
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
(this command) 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.
3/13/09 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
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&[email protected]&CertID=295&
CSRAddress1=111+Main&CSRLocality=Wilmington&CSRStateProvince=DE&
CSRPostalCode=00123&ResponseType=XML
In the response, an ErrCount value 0 confirms that the query was successful:
<?xml version="1.0" ?>
<interface-response>
<CertPurchaseCert>
<CertID>295</CertID>
</CertPurchaseCert>
<Command>CERTPURCHASECERT</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>LOCALHOST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.71875</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
CertConfigureCert
CertGetApproverEmail
CertGetCertDetail
CertGetCerts
CertModifyOrder
CertParseCSR
GetCerts
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
3/13/09 66
©2003-2009 Register.com, Inc. API commands: Check
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<DomainName>unusualtvname.tv</DomainName>
<PremiumName>
<IsPremiumName>False</IsPremiumName>
<PremiumPrice />
<PremiumAboveThresholdPrice>False</PremiumAboveThresholdPrice>
</PremiumName>
<RRPCode>210</RRPCode>
<RRPText>Domain available</RRPText>
<AuctionDate />
<AuctionID />
<Command>CHECK</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>Reseller4</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.172</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
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
3/13/09 69
©2003-2009 Register.com, Inc. API commands: CheckLogin
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<PartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</PartyID>
<Reseller>True</Reseller>
<ParentAccount>000-00-0000</ParentAccount>
<IsGPN>1</IsGPN>
<RSA>False</RSA>
<SiteType>E</SiteType>
<HelpEmailAddress>[email protected]</HelpEmailAddress>
3/13/09 70
©2003-2009 Register.com, Inc. API commands: CheckLogin
<AgreementStatus>
<Agreement>
<Type>1</Type>
<Description>ResellerAgreement</Description>
<Category>ResellerAgreement</Category>
<RemoteURL />
<LatestVersion>2.4</LatestVersion>
<Agreed>0</Agreed>
<CurrentCompliance>1</CurrentCompliance>
<AgreementNote />
</Agreement>
<Agreement>
<Type>4</Type>
<Description>ResellerNotification</Description>
<Category>ResellerNotification</Category>
<RemoteURL />
<LatestVersion>12</LatestVersion>
<Agreed>1</Agreed>
<CurrentCompliance>1</CurrentCompliance>
<AgreementNote />
</Agreement>
</AgreementStatus>
<AgreementCount />
<ParentAccount>000-00-0000</ParentAccount>
<Enforced>False</Enforced>
<ViewAgreement>True</ViewAgreement>
<CartItems>3</CartItems>
<Command>CHECKLOGIN</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.266</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
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
3/13/09 72
©2003-2009 Register.com, Inc. API commands: CheckNSStatus
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<NsCheckSuccess>1</NsCheckSuccess>
<CheckNsStatus>
<version>0</version>
<name>dns01.gpn.register.com</name>
<status>
<status>ok</status>
<status>linked</status>
</status>
<ipaddress>63.251.83.37</ipaddress>
<attrib-id>5232127_HOST_CNE-VRSN</attrib-id>
<attrib-crdate>2002-01-15T20:34:07.0000Z</attrib-crdate>
<attrib-update>2002-04-18T17:35:43.0000Z</attrib-update>
<attrib-upid>y2ktest</attrib-upid>
<attrib-crid>rccbatch</attrib-crid>
<attrib-clid>024</attrib-clid>
</CheckNsStatus>
<RRPCode />
<RRPText />
<Command>CHECKNSSTATUS</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>1.125</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
3/13/09 73
©2003-2009 Register.com, Inc. API commands: CheckNSStatus
</debug>
</interface-response>
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
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:
<?xml version="1.0" ?>
<interface-response>
<CommissionAccount>
<Action />
<data-errors />
<CommissionBalance>6.69</CommissionBalance>
<AvailComBalance>0</AvailComBalance>
</CommissionAccount>
<Command>COMMISSIONACCOUNT</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 77
©2003-2009 Register.com, Inc. API commands: Contacts
3/13/09 78
©2003-2009 Register.com, Inc. API commands: Contacts
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&
TechCountry=USA&[email protected]&responsetype=xml
The error count of 0 in the response confirms that the query was successful:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Command>CONTACTS</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 81
©2003-2009 Register.com, Inc. API commands: CreateAccount
3/13/09 82
©2003-2009 Register.com, Inc. API commands: CreateAccount
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:
<?xml version="1.0" ?>
<interface-response>
<NewAccount>
<StatusCustomerInfo>Successful</StatusCustomerInfo>
<PartyID>{8D504DD5-C773-41C4-83F6-4495CA479103}</PartyID>
<Account>154-dz-5567</Account>
<sLoginPass>
91DDFEF7E0E7F6A9DDFEF7E0E7F6A9A5BDA0A6BDA0A2A2A0B2A5A8A2A3A8A2AAB2C2DF
</sLoginPass>
</NewAccount>
<Command>CREATEACCOUNT</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 86
©2003-2009 Register.com, Inc. API commands: CreateSubAccount
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter
Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
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:
<?xml version="1.0" ?>
<interface-response>
<NewAccount>
<StatusCustomerInfo>Successful</StatusCustomerInfo>
<PartyID>{B301E3A9-1BFF-4600-9B2D-D214C29325A9}</PartyID>
<Account>661-zw-1374</Account>
</NewAccount>
<Command>CREATESUBACCOUNT</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
CheckLogin
CreateAccount
GetAccountInfo
GetAccountPassword
GetAllAccountInfo
GetOrderDetail
GetOrderList
GetReport
GetSubAccountDetails
GetSubAccounts
GetTransHistory
SubAccountDomains
UpdateAccountInfo
UpdateCusPreferences
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
3/13/09 89
©2003-2009 Register.com, Inc. API commands: DeleteAllPOPPaks
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Command>DELETEALLPOPPAKS</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
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:
<?xml version="1.0" ?>
<interface-response>
<Command>DELETECONTACT</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>1.082</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
AddContact
GetAddressBook
GetContacts
GetSubAccounts
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
3/13/09 93
©2003-2009 Register.com, Inc. API commands: DeleteCustomerDefinedData
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<Command>DELETECUSTOMERDEFINEDDATA</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 95
©2003-2009 Register.com, Inc. API commands: DeleteFromCart
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<ItemDeleted>True</ItemDeleted>
<Command>DELETEFROMCART</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 97
©2003-2009 Register.com, Inc. API commands: DeleteHostedDomain
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<DeleteHostedDomain>
<OldRegistrationStatus>Hosted</OldRegistrationStatus>
<Status>Success</Status>
</DeleteHostedDomain>
<Command>DELETEHOSTEDDOMAIN</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>Reseller3</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.15625</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
ExtendDomainDNS
PurchaseHosting
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
3/13/09 99
©2003-2009 Register.com, Inc. API commands: DeleteNameServer
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegisterNameserver>
<RegistrarLock>ACTIVE</RegistrarLock>
<NsSuccess>1</NsSuccess>
<RegistrarLock>REGISTRAR-LOCK</RegistrarLock>
</RegisterNameserver>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
<Command>DELETENAMESERVER</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 102
©2003-2009 Register.com, Inc. API commands: DeletePOP3
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Command>DELETEPOP3</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 104
©2003-2009 Register.com, Inc. API commands: DeletePOPPak
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Command>DELETEPOPPAK</Command>
<ErrCount>0</ErrCount>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
DeleteAllPOPPaks
DeletePOP3
Forwarding
GetForwarding
GetMailHosts
GetPOP3
ModifyPOP3
PurchasePOPBundle
SetUpPOP3User
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
3/13/09 106
©2003-2009 Register.com, Inc. API commands: DeleteRegistration
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<interface-response>
<deletedomain>
<domaindeleted>True</domaindeleted>
</deletedomain>
<ErrString/>
<ErrSource/>
<ErrSection>DELETEREGISTRATION</ErrSection>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
<Command>DELETEREGISTRATION</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>2.75</ExecTime>
<Done>true</Done>
3/13/09 107
©2003-2009 Register.com, Inc. API commands: DeleteRegistration
<debug>
[CDATA ]
</debug>
</interface-response>
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
3/13/09 109
©2003-2009 Register.com, Inc. API commands: DeleteSubaccount
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DeleteSubAccount>
<Action>DELETE</Action>
</DeleteSubAccount>
<Command>DELETESUBACCOUNT</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>e</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.1523438</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 111
©2003-2009 Register.com, Inc. API commands: DisableServices
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Service>WPPS</Service>
<ServiceStatus>Disabled</ServiceStatus>
<Command>DISABLESERVICES</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>LOCALHOST</Server>
<Site>rcom</Site>
<IsLockable>1</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 113
©2003-2009 Register.com, Inc. API commands: EnableServices
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Service>WPPS</Service>
<ServiceStatus>Enabled</ServiceStatus>
<Command>ENABLESERVICES</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>LOCALHOST</Server>
<Site>rcom</Site>
<IsLockable>1</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 116
©2003-2009 Register.com, Inc. API commands: Extend
3/13/09 117
©2003-2009 Register.com, Inc. API commands: Extend
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&Response-
Type=XML
The response confirms the successful extension of the registration period for the domain:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<Extension>successful</Extension>
<DomainName>partnerdomain.com</DomainName>
<OrderID>156062933</OrderID>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
<Command>EXTEND</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 120
©2003-2009 Register.com, Inc. API commands: Extend_RGP
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=rcompart-
nerid&pw=rcompartnerpw&
sld=VeryExpiredName&tld=com&ResponseType=xml
In the response, the Extension value Successful value confirms that the query was successful:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Extension>successful</Extension>
<DomainName>VeryExpiredName.com</DomainName>
<OrderID>156251141</OrderID>
<Command>EXTEND_RGP</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.2109375</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
3/13/09 121
©2003-2009 Register.com, Inc. API commands: Extend_RGP
</debug>
</interface-response>
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
3/13/09 123
©2003-2009 Register.com, Inc. API commands: ExtendDomainDNS
3/13/09 124
©2003-2009 Register.com, Inc. API commands: ExtendDomainDNS
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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&[email protected]&
UseCreditCard=yes&CardType=mastercard&CCName=John+Doe&
CreditCardNumber=5555555555555555&CreditCardExpMonth=05&CreditCardExpYear=2005&
cVV2=555&ccAddress=17462&ChargeAmount=12&responsetype=xml
In the response, the order ID and the ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
3/13/09 125
©2003-2009 Register.com, Inc. API commands: ExtendDomainDNS
<RegistrarHold>False</RegistrarHold>
<CCTRANSRESULT>APPROVED</CCTRANSRESULT>
<OrderID>156180311</OrderID>
<Command>EXTENDDOMAINDNS</Command>
<ErrCount>0</ErrCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
AddToCart
DeleteHostedDomain
Extend
InsertNewOrder
Purchase
PurchaseHosting
PurchasePOPBundle
PurchaseServices
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
3/13/09 127
©2003-2009 Register.com, Inc. API commands: Forwarding
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater 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&
Address1=jane.doe&[email protected]&
Address2=john.doe&[email protected]&ResponseType=XML
The error count 0 confirms that the email forwarding instructions are successful:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<MailCount>2</MailCount>
<Command>FORWARDING</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 130
©2003-2009 Register.com, Inc. API commands: GetAccountInfo
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetAccountInfo>
<UserID>rcompartnerid</UserID>
<Password>rcompartnerpw</Password>
<AuthQuestionType>smaiden</AuthQuestionType>
<AuthQuestionAnswer>Jones</AuthQuestionAnswer>
<Account>217-no-0647</Account>
<Reseller>True</Reseller>
<AcceptTerms>True</AcceptTerms>
</GetAccountInfo>
<Command>GETACCOUNTINFO</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
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&response-
type=xml
In the response, the true value for GotAccountInfo and the 0 value for ErrCount indicate that the query was
successful. The password is sent to the registrant e-mail address almost instantly.
<?xml version="1.0" ?>
<interface-response>
<GetSubAcctLogin>
<GotAccountInfo>true</GotAccountInfo>
</GetSubAcctLogin>
<Command>GETACCOUNTPASSWORD</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
CheckLogin
CreateAccount
CreateSubAccount
GetAccountInfo
GetAccountValidation
GetAllAccountInfo
GetOrderDetail
GetOrderList
GetReport
GetSubAccountDetails
GetSubAccounts
GetTransHistory
SendAccountEmail
UpdateAccountInfo
UpdateCusPreferences
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
3/13/09 135
©2003-2009 Register.com, Inc. API commands: GetAccountValidation
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetAcctValidation>
<AuthQuestionType>Mother's Maiden Name</AuthQuestionType>
<AuthQuestionAnswer>Smith</AuthQuestionAnswer>
<LoginID>giambi</LoginID>
</GetAcctValidation>
<Command>GETACCOUNTVALIDATION</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.0390625</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 137
©2003-2009 Register.com, Inc. API commands: GetAddressBook
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:
<?xml version="1.0" ?>
<interface-response>
<AddressBook>
3/13/09 138
©2003-2009 Register.com, Inc. API commands: GetAddressBook
<Address rec="0">
<PartyId>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</PartyId>
<OrganizationName>Partner Domains Inc.</OrganizationName>
<JobTitle>President</JobTitle>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<Address1>111 Main St.</Address1>
<Address2 />
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<StateProvinceChoice>S</StateProvinceChoice>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>+1.5555555555</Phone>
<PhoneExt />
<Fax>+1.5555555556</Fax>
<Email>[email protected]</Email>
</Address>
<Address rec="2">
<PartyId>{AD45BE6C-B3FA-4F7D-ADC1-A1D5B97EAB4B}</PartyId>
<OrganizationName>eMachines, Inc.</OrganizationName>
<JobTitle />
<FirstName>Administration,</FirstName>
<LastName>Domains</LastName>
<Address1>14350 Myford Rd. Bldg. #100</Address1>
<Address2 />
<City>Irvine</City>
<StateProvince>CA</StateProvince>
<StateProvinceChoice>S</StateProvinceChoice>
<PostalCode>92606</PostalCode>
<Country>US</Country>
<Phone>(714) 481-2828</Phone>
<PhoneExt />
<Fax />
<Email>[email protected]</Email>
</Address>
.
.
.
<Count>100</Count>
<TotalPages>3</TotalPages>
</AddressBook>
<Command>GETADDRESSBOOK</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>6.515625</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 141
©2003-2009 Register.com, Inc. API commands: GetAllAccountInfo
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<OrganizationName>Partner Domains Inc.</OrganizationName>
<JobTitle>President</JobTitle>
<Fname>John</Fname>
<Lname>Doe</Lname>
<Address1>111 Main St.</Address1>
3/13/09 142
©2003-2009 Register.com, Inc. API commands: GetAllAccountInfo
<Address2 />
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<StateProvinceChoice>S</StateProvinceChoice>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>5555555555</Phone>
<Fax>5555555556</Fax>
<EmailAddress>[email protected] </EmailAddress>
<URL />
<GetAccountInfo>
<UserID>rcompartnerid</UserID>
<Password>rcompartnerpw</Password>
<AuthQuestionType>smaiden</AuthQuestionType>
<AuthQuestionAnswer>Jones</AuthQuestionAnswer>
<Account>217-no-0647</Account>
<Reseller>True</Reseller>
<AcceptTerms>True</AcceptTerms>
</GetAccountInfo>
<GetCustomerPaymentInfo>
<CCName />
<CCNumber />
<CCType />
<CCMonth />
<CCYear />
</GetCustomerPaymentInfo>
<GetCustomerPreferences>
<DefPeriod />
</GetCustomerPreferences>
<Command>GETALLACCOUNTINFO</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 144
©2003-2009 Register.com, Inc. API commands: GetAllDomains
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetAllDomains>
<DomainDetail>
<DomainName>partnerdomain.com</DomainName>
<DomainNameID>317534985</DomainNameID>
<expiration-date>6/23/2005 6:44:19 PM</expiration-date>
</DomainDetail>
<DomainDetail>
<DomainName>partnerdomain2.net</DomainName>
<DomainNameID>317564218</DomainNameID>
<expiration-date>6/23/2005 6:53:23 PM</expiration-date>
</DomainDetail>
<DomainDetail>
3/13/09 145
©2003-2009 Register.com, Inc. API commands: GetAllDomains
<DomainName>partnerdomain3.info</DomainName>
<DomainNameID>152533676</DomainNameID>
<expiration-date>6/23/2005 7:15:50 PM</expiration-date>
</DomainDetail>
.
.
.
<UserRequestStatus>DomainBox</UserRequestStatus>
</GetAllDomains>
<Command>GETALLDOMAINS</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
GetDomainCount
GetDomainExp
GetDomainInfo
GetDomains
GetExtendInfo
GetHomeDomainList
GetPasswordBit
GetRegistrationStatus
GetRegLock
GetRenew
GetSubAccountPassword
SetPassword
SetRegLock
SetRenew
StatusDomain
ValidatePassword
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
3/13/09 147
©2003-2009 Register.com, Inc. API commands: GetBalance
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<Reseller>1</Reseller>
<Balance>3,709.20</Balance>
<AvailableBalance>3,669.40</AvailableBalance>
<DomainCount>74</DomainCount>
<Command>GETBALANCE</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 149
©2003-2009 Register.com, Inc. API commands: GetCartContent
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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):
<?xml version="1.0" ?>
<interface-response>
<GetCartContent>
<item>
<ItemID>393955</ItemID>
<Description>Register</Description>
<ProdType>10</ProdType>
<Years>1</Years>
<NameID>152556457</NameID>
<Name>partnerdomain.us</Name>
<StatusID>I</StatusID>
<ItemPrice>10.00</ItemPrice>
<Renew>0</Renew>
<cd>
3/13/09 150
©2003-2009 Register.com, Inc. API commands: GetCartContent
<NeedsConfig>1</NeedsConfig>
<IsMailPak>0</IsMailPak>
<ShowWPPSLink>1</ShowWPPSLink>
<p>
<QtyDesc>Year(s)</QtyDesc>
<SubItem>0</SubItem>
<FreeTrial>0</FreeTrial>
</p>
</cd>
</item>
</GetCartContent>
<Command>GETCARTCONTENT</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug><![CDATA [ ] ]></debug>
</interface-response>
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
3/13/09 152
©2003-2009 Register.com, Inc. API commands: GetCatchAll
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<CatchAll>[email protected]</CatchAll>
<Command>GETCATCHALL</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.125</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
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
3/13/09 154
©2003-2009 Register.com, Inc. API commands: GetCerts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetCerts>
<Reseller>True</Reseller>
<Certs>
<Cert1>
<ProdCode>certificate-rapidssl-rapidssl</ProdCode>
<ProdType>23</ProdType>
<ProdDesc>SSL Certificate - RapidSSL</ProdDesc>
<QtyDesc>Year(s)</QtyDesc>
<RetailPrice>$78.00</RetailPrice>
<ResellerPrice>$9.95</ResellerPrice>
<Enabled>True</Enabled>
<Years>1</Years>
<Years>2</Years>
<Years>3</Years>
<Years>4</Years>
<Years>5</Years>
</Cert1>
<Cert2>
<ProdCode>certificate-geotrust-quickssl</ProdCode>
<ProdType>26</ProdType>
<ProdDesc>SSL Certificate - GeoTrust QuickSSL</ProdDesc>
<QtyDesc>Year(s)</QtyDesc>
<RetailPrice>$500.00</RetailPrice>
<ResellerPrice>$69.00</ResellerPrice>
<Enabled>True</Enabled>
<Years>1</Years>
<Years>2</Years>
<Years>3</Years>
<Years>4</Years>
3/13/09 155
©2003-2009 Register.com, Inc. API commands: GetCerts
<Years>5</Years>
</Cert2>
.
.
.
</Certs>
<CertCount>10</CertCount>
</GetCerts>
<Command>GETCERTS</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.1992188</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
CertConfigureCert
CertGetApproverEmail
CertGetCertDetail
CertGetCerts
CertModifyOrder
CertParseCSR
CertPurchaseCert
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
3/13/09 157
©2003-2009 Register.com, Inc. API commands: GetConfirmationSettings
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<ConfirmationSettings>
<OrderConfirmation>True</OrderConfirmation>
<TransferOrderConfirmation>True</TransferOrderConfirmation>
<OrderConfirmationBCC>True</OrderConfirmationBCC>
<TransferOrderConfirmationBCC>True</TransferOrderConfirmationBCC>
<EmailHead>Thank you for your recent order.</EmailHead>
<EmailTail>Thanks again for using our online services.</EmailTail>
</ConfirmationSettings>
<Command>GETCONFIRMATIONSETTINGS</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>8.203125E-02</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 160
©2003-2009 Register.com, Inc. API commands: GetContacts
3/13/09 161
©2003-2009 Register.com, Inc. API commands: GetContacts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<GetContacts>
<domainname
sld="partnerdomain" tld="com" domainnameid="152533676">partnerdomain.com
</domainname>
<Registrant>
<RegistrantPartyID>{F6A676E4-5BB7-453C-87A6-9BBB164318F5}
</RegistrantPartyID>
<RegistrantAddress1>100 Main St.</RegistrantAddress1>
<RegistrantAddress2 />
<RegistrantCity>Townsville</RegistrantCity>
<RegistrantCountry>US</RegistrantCountry>
<RegistrantEmailAddress>[email protected]</RegistrantEmailAddress>
<RegistrantFax />
<RegistrantFirstName>John</RegistrantFirstName>
<RegistrantJobTitle />
<RegistrantLastName>Smith</RegistrantLastName>
<RegistrantOrganizationName />
<RegistrantPhone>5555555555</RegistrantPhone>
<RegistrantPostalCode />
<RegistrantStateProvince />
<RegistrantStateProvinceChoice />
</Registrant>
<AuxBilling>None</AuxBilling>
<Tech>None</Tech>
<Admin>None</Admin>
<Billing>
3/13/09 162
©2003-2009 Register.com, Inc. API commands: GetContacts
<BillingPartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</BillingPartyID>
<BillingAddress1>111 Main Street</BillingAddress1>
<BillingAddress2 />
<BillingCity>Hometown</BillingCity>
<BillingCountry>US</BillingCountry>
<BillingEmailAddress>[email protected]</BillingEmailAddress>
<BillingFax>555-555-5556</BillingFax>
<BillingFirstName>John</BillingFirstName>
<BillingJobTitle>President</BillingJobTitle>
<BillingLastName>Doe</BillingLastName>
<BillingOrganizationName>Partner Domains Inc.</BillingOrganizationName>
<BillingPhone>555-555-5555</BillingPhone>
<BillingPostalCode>99999</BillingPostalCode>
<BillingStateProvince>NY</BillingStateProvince>
<BillingStateProvinceChoice>S</BillingStateProvinceChoice>
<BillingFullCountry>United States</BillingFullCountry>
<UseBelowAuxInfo>True</UseBelowAuxInfo>
<auxID />
<regID>{F6A676E4-5BB7-453C-87A6-9BBB164318F5}</regID>
</Billing>
</GetContacts>
<Command>GETCONTACTS</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 164
©2003-2009 Register.com, Inc. API commands: GetCusPreferences
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<CustomerPrefs>
<DefPeriod>4</DefPeriod>
<AllowDNS>False</AllowDNS>
<ShowPopups>False</ShowPopups>
<AutoRenew>False</AutoRenew>
<RegLock>False</RegLock>
<AutoPakRenew>False</AutoPakRenew>
<UseDNS>True</UseDNS>
<ResellerStatus />
<RenewalSetting>0</RenewalSetting>
<RenewalBCC>0</RenewalBCC>
<RenewalURLForward>False</RenewalURLForward>
<RenewalEmailForward>False</RenewalEmailForward>
</CustomerPrefs>
<CustomerInformation>
<AcceptTerms>True</AcceptTerms>
<URL />
</CustomerInformation>
<Command>GETCUSPREFERENCES</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>0</IsLockable>
<IsRealTimeTLD>0</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 167
©2003-2009 Register.com, Inc. API commands: GetCustomerDefinedData
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<CustomerData>
<Value>Italian</Value>
<DisplayFlag>True</DisplayFlag>
<EnteredBy>John</EnteredBy>
<LastUpdatedDate>7/7/2003 5:46:10 PM</LastUpdatedDate>
</CustomerData>
<Command>GETCUSTOMERDEFINEDDATA</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 170
©2003-2009 Register.com, Inc. API commands: GetCustomerPaymentInfo
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetCustomerPaymentInfo>
<CCName>John Doe</CCName>
<CCNumber>************5215</CCNumber>
<CCType>MASTERCARD</CCType>
<CCMonth>11</CCMonth>
<CCYear>2005</CCYear>
<CCAddress>17462</CCAddress>
<CCZip>98052</CCZip>
<CCCity>Hometown</CCCity>
<CCStateProvince>NY</CCStateProvince>
<CCCountry>US</CCCountry>
<CCPhoneDial>1</CCPhoneDial>
<CCPhone>5555559999</CCPhone>
</GetCustomerPaymentInfo>
<Command>GETCUSTOMERPAYMENTINFO</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>8.203125E-02</ExecTime>
<Done>true</Done>
<debug>
3/13/09 171
©2003-2009 Register.com, Inc. API commands: GetCustomerPaymentInfo
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 173
©2003-2009 Register.com, Inc. API commands: GetDNS
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<dns>dns01.gpn.register.com</dns>
<dns>dns02.gpn.register.com</dns>
<dns>dns03.gpn.register.com</dns>
<dns>dns04.gpn.register.com</dns>
<dns>dns05.gpn.register.com</dns>
<UseDNS>ours</UseDNS>
<NSStatus>Yes</NSStatus>
<RRPCode />
<RRPText />
<Command>GETDNS</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 175
©2003-2009 Register.com, Inc. API commands: GetDNSStatus
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<UseDNS>ours</UseDNS>
<HostsNumLimit>15</HostsNumLimit>
<Command>GETDNSSTATUS</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 177
©2003-2009 Register.com, Inc. API commands: GetDomainCount
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegisteredCount>72</RegisteredCount>
<HostCount>2</HostCount>
<ExpiredDomainsCount>0</ExpiredDomainsCount>
<ProcessCount>0</ProcessCount>
<KeywordCount>0</KeywordCount>
<WatchlistCount>0</WatchlistCount>
<CartItemCount>2</CartItemCount>
<ExpiringCount>0</ExpiringCount>
<Command>GETDOMAINCOUNT</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 180
©2003-2009 Register.com, Inc. API commands: GetDomainExp
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<ExpirationDate>6/25/2012 4:20:24 PM</ExpirationDate>
<Command>GETDOMAINEXP</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 182
©2003-2009 Register.com, Inc. API commands: GetDomainInfo
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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
3/13/09 184
©2003-2009 Register.com, Inc. API commands: GetDomainInfo
<type>FRAME</type>
<address>
<![CDATA[ 127.0.0.1 ] ]>
</address>
<mxpref>10</mxpref>
</host>
</configuration>
</entry>
<entry name="wsb">
<service changable="1">1066</service>
<configuration changable="1" type="wsb">
<wsb>rcomwebid</wsb>
</configuration>
</entry>
<entry name="emailset">
<service changable="1">1114</service>
<configuration changable="1" type="pop">
<pop>
<username>
<![CDATA[ john.doe ] ]>
</username>
</pop>
</configuration>
</entry>
<entry name="wpps">
<service changable="1">1120</service>
<configuration changable="1" type="wpps">
<wpps>
<cloakedemail>[email protected]</cloakedemail>
<forward-to>[email protected]</forward-to>
<expiredate>Nov 26, 2006</expiredate>
<autorenew>No</autorenew>
</wpps>
</configuration>
</entry>
<entry name="messaging">
<service changable="1">1087</service>
</entry>
</services>
</GetDomainInfo>
<RRPCode />
<RRPText />
<Command>GETDOMAININFO</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.390625</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 187
©2003-2009 Register.com, Inc. API commands: GetDomainNameID
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<SLD>partnerdomain</SLD>
<TLD>com</TLD>
<DomainNameID>152533676</DomainNameID>
<Command>GETDOMAINNAMEID</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 189
©2003-2009 Register.com, Inc. API commands: GetDomains
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:
<?xml version="1.0" ?>
<interface-response>
<GetDomains>
<tab>iown</tab>
<domain-list type="Registered">
<domain>
<DomainNameID>152533676</DomainNameID>
<sld>partnerdomain</sld>
<tld>com</tld>
<Renew>Yes</Renew>
<expiration-date>6/25/2012</expiration-date>
</domain>
<domain>
<DomainNameID>152533677</DomainNameID>
<sld>partnerdomain3</sld>
<tld>info</tld>
<Renew>Yes</Renew>
<expiration-date>6/25/2004</expiration-date>
</domain>
.
.
.
</domain-list>
<EndPosition>25</EndPosition>
<PreviousRecords>0</PreviousRecords>
<NextRecords>26</NextRecords>
<OrderBy />
<Result>True</Result>
<StartPosition>1</StartPosition>
<DomainCount>72</DomainCount>
<TotalDomainCount>72</TotalDomainCount>
<StartLetter />
</GetDomains>
<Command>GETDOMAINS</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
</interface-response>
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 value-
add 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
3/13/09 193
©2003-2009 Register.com, Inc. API commands: GetDomainServices
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<domainservices>
<website>0</website>
<phone>False</phone>
<ipresolver>0</ipresolver>
<map>False</map>
<domainnameid>152551776</domainnameid>
<valueadd>
<EmailForwarding>0</EmailForwarding>
<EmailForwardExpDate />
<EmailAutoRenew />
<URLForwarding>0</URLForwarding>
<URLForwardExpDate />
<URLAutoRenew />
<emailForwardingPrice>0.00</emailForwardingPrice>
<urlForwardingPrice>0.00</urlForwardingPrice>
</valueadd>
</domainservices>
<Command>GETDOMAINSERVICES</Command>
<ErrCount>0</ErrCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
3/13/09 194
©2003-2009 Register.com, Inc. API commands: GetDomainServices
<IsLockable>0</IsLockable>
<IsRealTimeTLD>0</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 196
©2003-2009 Register.com, Inc. API commands: GetDomainSLDTLD
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<SLD>partnerdomain</SLD>
<TLD>com</TLD>
<DomainNameID>152533676</DomainNameID>
<Command>GETDOMAINSLDTLD</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 198
©2003-2009 Register.com, Inc. API commands: GetDomainSRVHosts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<srv-records>
<srv>
<HostID>17217418</HostID>
<HostName>_imap</HostName>
<Protocol>_TCP</Protocol>
<Address>imap.partnerdomain.com.</Address>
<RecordType>SRV</RecordType>
<mxPref>0</mxPref>
<Weight>50</Weight>
<priority>10</priority>
<Port>1</Port>
</srv>
<srv>
<HostID>17217420</HostID>
<HostName>_xmpp</HostName>
<Protocol>_UDP</Protocol>
<Address>xmpp.partnerdomain.com.</Address>
<RecordType>SRV</RecordType>
<mxPref>0</mxPref>
<Weight>50</Weight>
<priority>10</priority>
<Port>98</Port>
</srv>
</srv-records>
<Command>GETDOMAINSRVHOSTS</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
3/13/09 199
©2003-2009 Register.com, Inc. API commands: GetDomainSRVHosts
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.047</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
GetDomainInfo
GetHosts
SetDomainSRVHosts
SetHosts
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
3/13/09 201
©2003-2009 Register.com, Inc. API commands: GetDomainStatus
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainStatus>
<DomainName>partnerdomain.co.uk</DomainName>
<InAccount>0</InAccount>
<StatusDesc>Awaiting Registry Response</StatusDesc>
<OrderID>156162742</OrderID>
</DomainStatus>
<Command>GETDOMAINSTATUS</Command>
<ErrCount>0</ErrCount>
<Server>Test1</Server>
<Site>rcom</Site>
<IsLockable>False</IsLockable>
<IsRealTimeTLD>False</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 204
©2003-2009 Register.com, Inc. API commands: GetDomainSubServices
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<DomainServices>
<EmailForwarding>True</EmailForwarding>
<HostRecords>True</HostRecords>
</DomainServices>
<Command>GETDOMAINSUBSERVICES</Command>
<ErrCount>0</ErrCount>
<Server>Dev</Server>
<Site>rcom</Site>
<Done>true</Done>
</interface-response>
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
3/13/09 206
©2003-2009 Register.com, Inc. API commands: GetDotNameForwarding
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<dotnameforwarding>
<domainname domainnameid="157171163" sld="john.doe" tld="name" />
<status>1</status>
<address>[email protected]</address>
</dotnameforwarding>
<Command>GETDOTNAMEFORWARDING</Command>
<ErrCount>0</ErrCount>
<Server>Reseller5</Server>
<Site>rcom</Site>
<IsLockable>False</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 208
©2003-2009 Register.com, Inc. API commands: GetExpiredDomains
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainDetail>
<DomainName>northwestcrafts.com</DomainName>
<DomainNameID>152139242</DomainNameID>
<status>Extended RGP</status>
<expiration-date>2/26/2003</expiration-date>
<lockstatus>Locked</lockstatus>
</DomainDetail>
<DomainDetail>
<DomainName>fabrics-wallpaper.com</DomainName>
<DomainNameID>152134074</DomainNameID>
<status>RGP</status>
<expiration-date>3/1/2003 6:54:40 AM</expiration-date>
<lockstatus>Locked</lockstatus>
</DomainDetail>
<DomainDetail>
<DomainName>onlinebrochure.com</DomainName>
<DomainNameID>152129772</DomainNameID>
<status>RGP</status>
<expiration-date>6/4/2002 6:18:36 PM</expiration-date>
<lockstatus>Locked</lockstatus>
</DomainDetail>
<DomainDetail>
<DomainName>eweathervane.com</DomainName>
<DomainNameID>2062920</DomainNameID>
<status>Expired</status>
<expiration-date>3/8/2002 2:14:45 AM</expiration-date>
<lockstatus>Locked</lockstatus>
</DomainDetail>
<DomainDetail>
<DomainName>signonworldwide.com</DomainName>
<DomainNameID>2063248</DomainNameID>
<status>Expired</status>
<expiration-date>3/8/2002 11:38:32 PM</expiration-date>
<lockstatus>Locked</lockstatus>
3/13/09 209
©2003-2009 Register.com, Inc. API commands: GetExpiredDomains
</DomainDetail>
<DomainDetail>
<DomainName>Youcanhelp.net</DomainName>
<DomainNameID>152151738</DomainNameID>
<status>Expired</status>
<expiration-date>3/7/2002 6:44:29 PM</expiration-date>
<lockstatus>Locked</lockstatus>
</DomainDetail>
<DomainDetail>
<DomainName>ccpays.com</DomainName>
<DomainNameID>2082140</DomainNameID>
<status>Extended RGP</status>
<expiration-date>4/26/2002 4:01:46 PM</expiration-date>
<lockstatus>Locked</lockstatus>
</DomainDetail>
.
.
.
<domaincount>120</domaincount>
<Command>GETEXPIREDDOMAINS</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>1.503906</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
AddToCart
Extend_RGP
GetDomainInfo
GetDomains
PE_SetPricing
Purchase
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 <Name> in the return of this command, and
permitted values for the Preconfigure command are tagged <Value> in the return for this command.
Availability
All 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
3/13/09 211
©2003-2009 Register.com, Inc. API commands: GetExtAttributes
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<Attributes>
<Attribute>
<ID>1</ID>
<Name>us_nexus</Name>
<Application>2</Application>
<UserDefined>False</UserDefined>
<Required>1</Required>
<Description>Nexus Category</Description>
<IsChild>0</IsChild>
<Options>
<Option>
<ID>12</ID>
<Value>C11</Value>
<Title>US Citizen</Title>
<Description>A natural person who is a US Citizen</Description>
</Option>
<Option>
3/13/09 212
©2003-2009 Register.com, Inc. API commands: GetExtAttributes
<ID>13</ID>
<Value>C12</Value>
<Title>Permanent Resident</Title>
<Description>A natural person who is a Permanent Resident</Description>
</Option>
.
.
.
</Options>
</Attribute>
<Attribute>
<ID>4</ID>
<Name>global_cc_us</Name>
<Application>2</Application>
<UserDefined>False</UserDefined>
<Required>0</Required>
<Description>Country</Description>
<IsChild>1</IsChild>
<Options />
</Attribute>
<Attribute>
<ID>2</ID>
<Name>us_purpose</Name>
<Application>2</Application>
<UserDefined>False</UserDefined>
<Required>1</Required>
<Description>Application Purpose</Description>
<IsChild>0</IsChild>
<Options>
<Option>
<ID>17</ID>
<Value>P1</Value>
<Title>For Profit</Title>
<Description>Business use for profit</Description>
</Option>
<Option>
<ID>18</ID>
<Value>P2</Value>
<Title>Non-profit</Title>
<Description>Non-profit business, club, association, religious organization, etc.
</Description>
</Option>
.
.
.
</Options>
</Attribute>
</Attributes>
<Command>GETEXTATTRIBUTES</Command>
<ErrCount>0</ErrCount>
<Server>Reseller3</Server>
<Site>rcom</Site>
<IsLockable>False</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 215
©2003-2009 Register.com, Inc. API commands: GetExtendInfo
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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<Expiration>06/25/2004</Expiration>
<MaxExtension>8</MaxExtension>
<CCAuthorized>True</CCAuthorized>
<Price>10.00</Price>
<Balance>39.80</Balance>
<AvailableBalance>39.80</AvailableBalance>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
<Command>GETEXTENDINFO</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 218
©2003-2009 Register.com, Inc. API commands: GetForwarding
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<eforward>
<alias>jane.doe</alias>
<forward-to>[email protected]</forward-to>
</eforward>
<eforward>
<alias>john.doe</alias>
<forward-to>[email protected]</forward-to>
</eforward>
<EmailCount>2</EmailCount>
3/13/09 219
©2003-2009 Register.com, Inc. API commands: GetForwarding
<Command>GETFORWARDING</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 221
©2003-2009 Register.com, Inc. API commands: GetFraudScore
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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&
EndUserIP=127.0.0.1&[email protected]&Country=US&
ProductType=hosting&ChargeAmount=25&Quantity=1&responsetype=xml
In the response, a Score return value confirms that the query was successful:
<?xml version="1.0" ?>
<interface-response>
<Score>80</Score>
<Command>GETFRAUDSCORE</Command>
3/13/09 222
©2003-2009 Register.com, Inc. API commands: GetFraudScore
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site />
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>2.351563</ExecTime>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
Related commands
None
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
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:
<?xml version="1.0" ?>
<interface-response>
<GetGlobalChangeStatus>
<GlobalStatusInfo>
<RequestID>8332</RequestID>
<ReqDate>9/2/2003 3:51:47 PM</ReqDate>
<ReqTypeDesc>Registrar-lock on</ReqTypeDesc>
<ReqStatusDesc>Open</ReqStatusDesc>
</GlobalStatusInfo>
<GlobalStatusInfo>
<RequestID>8331</RequestID>
<ReqDate>9/2/2003 3:51:47 PM</ReqDate>
<ReqTypeDesc>Auto renew on</ReqTypeDesc>
<ReqStatusDesc>Open</ReqStatusDesc>
</GlobalStatusInfo>
<GlobalStatusInfo>
<RequestID>8326</RequestID>
<ReqDate>8/29/2003 5:19:00 PM</ReqDate>
<ReqTypeDesc>Auto renew on</ReqTypeDesc>
<ReqStatusDesc>Open</ReqStatusDesc>
</GlobalStatusInfo>
<GlobalStatusInfo>
<RequestID>8325</RequestID>
<ReqDate>8/29/2003 5:19:00 PM</ReqDate>
<ReqTypeDesc>Use Our DNS</ReqTypeDesc>
<ReqStatusDesc>Open</ReqStatusDesc>
</GlobalStatusInfo>
<GlobalStatusInfo>
<RequestID>8324</RequestID>
<ReqDate>8/29/2003 5:18:59 PM</ReqDate>
<ReqTypeDesc>Contact changes</ReqTypeDesc>
<ReqStatusDesc>Open</ReqStatusDesc>
</GlobalStatusInfo>
</GetGlobalChangeStatus>
<Command>GETGLOBALCHANGESTATUS</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
3/13/09 225
©2003-2009 Register.com, Inc. API commands: GetGlobalChangeStatus
</debug>
</interface-response>
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
3/13/09 227
©2003-2009 Register.com, Inc. API commands: GetGlobalChangeStatusDetail
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetGlobalChangeStatusDetail>
<GlobalStatusDetail>
<DomainName>TestSLD1.biz</DomainName>
<StatusDesc>Processed successfully</StatusDesc>
<ErrorDesc>none</ErrorDesc>
</GlobalStatusDetail>
<GlobalStatusDetail>
<DomainName>TestSLD2.com</DomainName>
<StatusDesc>Processed successfully</StatusDesc>
<ErrorDesc>none</ErrorDesc>
</GlobalStatusDetail>
<GlobalStatusDetail>
<DomainName>TestSLD3.biz</DomainName>
<StatusDesc>Processed successfully</StatusDesc>
<ErrorDesc>none</ErrorDesc>
</GlobalStatusDetail>
<GlobalStatusDetail>
<DomainName>TestSLD4.com</DomainName>
<StatusDesc>Processed successfully</StatusDesc>
<ErrorDesc>none</ErrorDesc>
</GlobalStatusDetail>
<GlobalStatusDetail>
<DomainName>TestSLD5.com</DomainName>
<StatusDesc>Processed successfully</StatusDesc>
<ErrorDesc>none</ErrorDesc>
</GlobalStatusDetail>
<GlobalStatusDetail>
<DomainName>TestSLD6.us</DomainName>
<StatusDesc>Processed successfully</StatusDesc>
<ErrorDesc>none</ErrorDesc>
</GlobalStatusDetail>
</GetGlobalChangeStatusDetail>
<Command>GETGLOBALCHANGESTATUSDETAIL</Command>
<ErrCount>0</ErrCount>
3/13/09 228
©2003-2009 Register.com, Inc. API commands: GetGlobalChangeStatusDetail
<Server>Reseller2</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 230
©2003-2009 Register.com, Inc. API commands: GetHomeDomainList
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetHomeDomains>
<StartPosition>1</StartPosition>
<Display>25</Display>
<OrderBy>TLD, SLD</OrderBy>
<NewStartPosition>1</NewStartPosition>
<DomainCount>16</DomainCount>
<TotalDomains>16</TotalDomains>
<Domains>
<Domain>
<ID>152542653</ID>
<Name>bajadazoo.biz</Name>
<RegStatus>Registered</RegStatus>
</Domain>
<Domain>
<ID>152542655</ID>
<Name>tomalotamous.biz</Name>
<RegStatus>Registered</RegStatus>
</Domain>
<Domain>
<ID>152544200</ID>
<Name>apophyleti.com</Name>
<RegStatus>Hosted</RegStatus>
</Domain>
<Domain>
<ID>152542612</ID>
<Name>pangolineament.com</Name>
<RegStatus>Registered</RegStatus>
</Domain>
.
3/13/09 231
©2003-2009 Register.com, Inc. API commands: GetHomeDomainList
.
.
<Domain>
<ID>152542654</ID>
<Name>terraforaminifer.net</Name>
<RegStatus>Registered</RegStatus>
</Domain>
</Domains>
</GetHomeDomains>
<Command>GETHOMEDOMAINLIST</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.125</ExecTime>
<Done>true</Done>
</interface-response>
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
3/13/09 233
©2003-2009 Register.com, Inc. API commands: GetHosts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<Website>0</Website>
<host>
<name>www</name>
<type>A</type>
<address>127.0.0.1</address>
</host>
<host>
<name>@</name>
<type>A</type>
<address>127.0.0.1</address>
</host>
<host>
<name>mail</name>
<type>MXE</type>
<mxpref>10</mxpref>
<address>127.0.0.1</address>
</host>
<Command>GETHOSTS</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA [ ] ]>
</debug>
</interface-response>
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
3/13/09 236
©2003-2009 Register.com, Inc. API commands: GetMailHosts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<EmailForwarding>True</EmailForwarding>
<HostName11>mail</HostName11>
<RecordType11>MXE</RecordType11>
<Address11>209.19.56.20</Address11>
<MXPref11>10</MXPref11>
<ServiceSelect>1051</ServiceSelect>
<Command>GETMAILHOSTS</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 239
©2003-2009 Register.com, Inc. API commands: GetMetaTag
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<metatags>
<titlebar>MY COOL TITLE</titlebar>
<sitedescription>MY SITE DESCRIPTION</sitedescription>
<keywords>MY SITE KEYWORDS</keywords>
<DomainNameID>152533676</DomainNameID>
</metatags>
<Command>GETMETATAG</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>False</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 241
©2003-2009 Register.com, Inc. API commands: GetOrderDetail
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<Order>
<OrderID>156062775</OrderID>
<Result>True</Result>
<BillDate>7/19/2002 3:42:29 PM</BillDate>
<CCRefNum />
<OrderBillAmount>$35.80</OrderBillAmount>
<AdjustToAccount />
<OrderDetail>
<ProductType>Register</ProductType>
<Description>partnerdomain2.net</Description>
<Status>Successful</Status>
<Quantity>2</Quantity>
<AmountPaid>$17.90</AmountPaid>
</OrderDetail>
<OrderDetail>
3/13/09 242
©2003-2009 Register.com, Inc. API commands: GetOrderDetail
<ProductType>Register</ProductType>
<Description>partnerdomain3.info</Description>
<Status>Successful</Status>
<Quantity>2</Quantity>
<AmountPaid>$17.90</AmountPaid>
</OrderDetail>
</Order>
<Command>GETORDERDETAIL</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
CheckLogin
CreateAccount
CreateSubAccount
GetAccountInfo
GetAccountPassword
GetAllAccountInfo
GetDomainStatus
GetOrderList
GetReport
GetSubAccountDetails
GetSubAccounts
GetTransHistory
RPT_GetReport
UpdateAccountInfo
UpdateCusPreferences
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
3/13/09 244
©2003-2009 Register.com, Inc. API commands: GetOrderList
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
3/13/09 245
©2003-2009 Register.com, Inc. API commands: GetOrderList
<OrderList>
<OrderDetail>
<OrderID>156062752</OrderID>
<OrderDate>7/19/2002 12:28:37 PM</OrderDate>
<StatusDesc>Order complete</StatusDesc>
<OrderProcessFlag>True</OrderProcessFlag>
</OrderDetail>
<OrderDetail>
<OrderID>156062751</OrderID>
<OrderDate>7/19/2002 12:15:27 PM</OrderDate>
<StatusDesc>Order complete</StatusDesc>
<OrderProcessFlag>True</OrderProcessFlag>
</OrderDetail>
<OrderDetail>
<OrderID>156062750</OrderID>
<OrderDate>7/19/2002 12:10:34 PM</OrderDate>
<StatusDesc>Order complete</StatusDesc>
<OrderProcessFlag>True</OrderProcessFlag>
</OrderDetail>
.
.
.
<ShowPreviousAndNext>Yes</ShowPreviousAndNext>
<ShowPreviousLink>Yes</ShowPreviousLink>
<PreviousStartPosition>1</PreviousStartPosition>
<ShowStart>26</ShowStart>
<ShowEnd>37</ShowEnd>
<ShowNextLink>No</ShowNextLink>
<RecordCount>37</RecordCount>
</OrderList>
<Command>GETORDERLIST</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
CheckLogin
CreateAccount
CreateSubAccount
GetAccountInfo
GetAccountPassword
GetAllAccountInfo
GetOrderDetail
GetReport
GetSubAccountDetails
GetSubAccounts
GetTransHistory
RPT_GetReport
UpdateAccountInfo
UpdateCusPreferences
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
3/13/09 247
©2003-2009 Register.com, Inc. API commands: GetPasswordBit
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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.
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<DomainPassword>userpw</DomainPassword>
<password-set>1</password-set>
<Command>GETPASSWORDBIT</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 249
©2003-2009 Register.com, Inc. API commands: GetPOP3
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<pop>
<username>jane</username>
<password>janepw</password>
<quota>1024</quota>
<expdate>7/26/2003 3:48:15 PM</expdate>
<AutoRenew>1</AutoRenew>
<BundleId>5105</BundleId>
</pop>
<pop>
<username>john</username>
<password>johnpw</password>
<quota>1024</quota>
<expdate>7/26/2003 3:48:15 PM</expdate>
<AutoRenew>1</AutoRenew>
<BundleId>5105</BundleId>
</pop>
<pop>
<username>john.doe</username>
<password>johndoe</password>
<quota>1024</quota>
<expdate>7/26/2003 3:48:15 PM</expdate>
<AutoRenew>1</AutoRenew>
<BundleId>5105</BundleId>
</pop>
<pop>
<username>test8</username>
<password>test8</password>
<quota>1024</quota>
<expdate>7/26/2003 3:48:15 PM</expdate>
<AutoRenew>1</AutoRenew>
<BundleId>5105</BundleId>
</pop>
<pop>
<username>james</username>
<password>rcompartnerpw</password>
<quota>1024</quota>
<expdate>8/15/2003 11:01:30 AM</expdate>
<AutoRenew>1</AutoRenew>
<BundleId>5134</BundleId>
</pop>
<EmailCount>5</EmailCount>
<Paks>
<Pak>
<BundleId>5105</BundleId>
<QtyPurchased>10</QtyPurchased>
<QtyAvailable>6</QtyAvailable>
<ExpDate>7/26/2003 3:48:15 PM</ExpDate>
<AutoRenew>1</AutoRenew>
</Pak>
3/13/09 251
©2003-2009 Register.com, Inc. API commands: GetPOP3
<Pak>
<BundleId>5134</BundleId>
<QtyPurchased>10</QtyPurchased>
<QtyAvailable>9</QtyAvailable>
<ExpDate>8/15/2003 11:01:30 AM</ExpDate>
<AutoRenew>1</AutoRenew>
</Pak>
<Count>2</Count>
</Paks>
<Command>GETPOP3</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
DeleteAllPOPPaks
DeletePOP3
DeletePOPPak
Forwarding
GetCatchAll
GetForwarding
GetMailHosts
GetPOPExpirations
GetPOPForwarding
ModifyPOP3
PurchasePOPBundle
RenewPOPBundle
SetPakRenew
SetPOPForwarding
SetUpPOP3User
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
3/13/09 253
©2003-2009 Register.com, Inc. API commands: GetPOPExpirations
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<popexpirations>
<pop>
<domain>partnerdomain.com</domain>
<bundleid>5105</bundleid>
<expdate>7/26/2003 3:48:15 PM</expdate>
</pop>
<pop>
<domain>partnerdomain.com</domain>
<bundleid>5134</bundleid>
<expdate>8/15/2003 11:01:30 AM</expdate>
</pop>
<pop>
<domain>partnerdomain.com</domain>
<bundleid>5735</bundleid>
<expdate>5/14/2004 4:20:40 PM</expdate>
</pop>
<count>3</count>
</popexpirations>
<Command>GETPOPEXPIRATIONS</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<ExecTime>8.984375E-02</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
3/13/09 254
©2003-2009 Register.com, Inc. API commands: GetPOPExpirations
</debug>
</interface-response>
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
3/13/09 256
©2003-2009 Register.com, Inc. API commands: GetPOPForwarding
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<popforwarding>
<domainname>partnerdomain.com</domainname>
<domainnameid>152533676</domainnameid>
<username>Y</username>
<forwardto>[email protected]</forwardto>
<active>1</active>
</popforwarding>
<Command>GETPOPFORWARDING</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.1132813</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 259
©2003-2009 Register.com, Inc. API commands: GetRegHosts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<hostrecords>
<host>
<hostID />
<HostName>www</HostName>
<Address />
<RecordType>CNAME</RecordType>
</host>
<host>
<hostID>16139887</hostID>
<HostName>@ (none)</HostName>
<Address>66.150.5.189</Address>
<RecordType>A</RecordType>
</host>
<host>
<hostID>16139888</hostID>
<HostName>photos</HostName>
<Address>photos.msn.com.</Address>
<RecordType>CNAME</RecordType>
</host>
.
.
.
<host>
<hostID />
<HostName>* (other)</HostName>
<Address />
3/13/09 260
©2003-2009 Register.com, Inc. API commands: GetRegHosts
<RecordType>CNAME</RecordType>
</host>
</hostrecords>
<ParkingEnabled>False</ParkingEnabled>
<ServiceSelect>1114</ServiceSelect>
<Command>GETREGHOSTS</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.406</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
GetHosts
GetMetaTag
SetDNSHost
SetHosts
UpdateMetaTag
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
3/13/09 262
©2003-2009 Register.com, Inc. API commands: GetRegistrationStatus
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<RegistrationStatus>Registered</RegistrationStatus>
<Command>GETREGISTRATIONSTATUS</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 264
©2003-2009 Register.com, Inc. API commands: GetRegLock
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<reg-lock>1</reg-lock>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
<Command>GETREGLOCK</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 267
©2003-2009 Register.com, Inc. API commands: GetRenew
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<auto-renew>1</auto-renew>
<Command>GETRENEW</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 270
©2003-2009 Register.com, Inc. API commands: GetReport
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetReport>
<FName>John</FName>
<LName>Doe</LName>
<Party>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</Party>
<ReportDetail>
<dn DomName="partnerdomain.com" nsstatus="No" registrationstatus="Hosted"
ExpirationDate="07/15/03" />
<dn DomName="partnerdomain2.net" nsstatus="Yes" registrationstatus="Registered"
ExpirationDate="06/25/04" />
<dn DomName="partnerdomain3.info" nsstatus="Yes" registrationstatus="Registered"
ExpirationDate="06/25/04" />
</ReportDetail>
3/13/09 271
©2003-2009 Register.com, Inc. API commands: GetReport
</GetReport>
<Command>GETREPORT</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
CheckLogin
CreateAccount
CreateSubAccount
GetAllAccountInfo
GetAccountPassword
GetAllAccountInfo
GetHomeDomainList
GetOrderDetail
GetOrderList
GetSubAccountDetails
GetSubAccounts
GetTransHistory
RPT_GetReport
UpdateAccountInfo
UpdateCusPreferences
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
3/13/09 273
©2003-2009 Register.com, Inc. API commands: GetResellerInfo
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<ResellerInfo>
<OrganizationName>Partner Domains Inc.</OrganizationName>
<FName>John</FName>
<LName>Doe</LName>
<Address1>111 Main St.</Address1>
<Address2 />
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<StateProvinceChoice>S</StateProvinceChoice>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>5555555555</Phone>
<Fax>5555555556</Fax>
<EmailAddress>[email protected]</EmailAddress>
<PhoneExt />
</ResellerInfo>
<Command>GETRESELLERINFO</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
3/13/09 274
©2003-2009 Register.com, Inc. API commands: GetResellerInfo
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 276
©2003-2009 Register.com, Inc. API commands: GetSPFHosts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<host>
<name>test</name>
<type>TXT</type>
<a-radio>off</a-radio>
<mx-radio>on</mx-radio>
<ptr-radio>on</ptr-radio>
<all-radio>on</all-radio>
<a-records>regular hostnames po</a-records>
<mx-records>mx servers to</mx-records>
<ip-records>127.0.0.1</ip-records>
<inc-records>myisp.net mydomain.com</inc-records>
<hostid>15195981</hostid>
</host>
<Command>GETSPFHOSTS</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
3/13/09 277
©2003-2009 Register.com, Inc. API commands: GetSPFHosts
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.171875</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 279
©2003-2009 Register.com, Inc. API commands: GetServiceContact
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<ServiceContact>
<Organization>Partner Domains Inc.</Organization>
<Address1>111 Main St.</Address1>
<Address2 />
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>+1.5555555555</Phone>
<Fax>+1.5555555556</Fax>
<EmailAddress>[email protected]</EmailAddress>
<URL />
<ResellerKey />
</ServiceContact>
<Command>GETSERVICECONTACT</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<ExecTime>8.203125E-02</ExecTime>
<Done>true</Done>
3/13/09 280
©2003-2009 Register.com, Inc. API commands: GetServiceContact
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 282
©2003-2009 Register.com, Inc. API commands: GetSubAccountDetails
3/13/09 283
©2003-2009 Register.com, Inc. API commands: GetSubAccountDetails
3/13/09 284
©2003-2009 Register.com, Inc. API commands: GetSubAccountDetails
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<SubAccountsManage>
<Action>MANAGE</Action>
<Set>
<SubAccount>154-dz-5567</SubAccount>
<AcctType>retail</AcctType>
<Prices>
<price tld="com" id="0" prod="10">19</price>
<price tld="com" id="0" prod="16">20</price>
<price tld="com" id="0" prod="19">21</price>
<price tld="net" id="1" prod="10">19</price>
<price tld="net" id="1" prod="16">20</price>
<price tld="net" id="1" prod="19">21</price>
<price tld="org" id="2" prod="10">19</price>
<price tld="org" id="2" prod="16">20</price>
<price tld="org" id="2" prod="19">21</price>
.
.
.
</Prices>
<data-errors />
</Set>
<Get>
<PartyID>{8D504DD5-C773-41C4-83F6-4495CA479103}</PartyID>
<LoginID>giambi</LoginID>
<DomainCount>3</DomainCount>
<Account>154-dz-5567</Account>
<Reseller>0</Reseller>
<pricestructure>
<product>
<tld>com</tld>
<registerprice>19</registerprice>
<registerenabled>True</registerenabled>
<renewprice>20</renewprice>
<renewenabled>True</renewenabled>
<transferprice>21</transferprice>
<transferenabled>True</transferenabled>
</product>
<product>
<tld>net</tld>
<registerprice>19</registerprice>
<registerenabled>True</registerenabled>
<renewprice>20</renewprice>
<renewenabled>True</renewenabled>
3/13/09 286
©2003-2009 Register.com, Inc. API commands: GetSubAccountDetails
<transferprice>21</transferprice>
<transferenabled>True</transferenabled>
</product>
<product>
<tld>org</tld>
<registerprice>19</registerprice>
<registerenabled>True</registerenabled>
<renewprice>20</renewprice>
<renewenabled>True</renewenabled>
<transferprice>21</transferprice>
<transferenabled>True</transferenabled>
</product>
.
.
.
</pricestructure>
</Get>
</SubAccountsManage>
<Command>GETSUBACCOUNTDETAILS</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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 e-
mailed 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
3/13/09 288
©2003-2009 Register.com, Inc. API commands: GetSubAccountPassword
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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.
<?xml version="1.0" ?>
<interface-response>
<Command>GETSUBACCOUNTPASSWORD</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 290
©2003-2009 Register.com, Inc. API commands: GetSubAccounts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<SubAccounts>
<SubAccount>
<PartyID>{AFCFAEC0-2FB6-4512-B043-EE6653618E1F}</PartyID>
<LoginID>resellsub</LoginID>
<DomainCount>0</DomainCount>
<Account>030-hi-7080</Account>
<Reseller>0</Reseller>
<FName>john</FName>
<LName>doe</LName>
<EmailAddress>[email protected]</EmailAddress>
</SubAccount>
.
.
.
<SubAccount>
<PartyID>{C5D65CB8-1522-422A-9B78-D004AF13ADF0}</PartyID>
<LoginID>testok</LoginID>
<DomainCount>0</DomainCount>
<Account>850-tn-1053</Account>
<Reseller>0</Reseller>
</SubAccount>
<Count>1</Count>
</SubAccounts>
<Command>GETSUBACCOUNTS</Command>
3/13/09 291
©2003-2009 Register.com, Inc. API commands: GetSubAccounts
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
CheckLogin
CreateAccount
CreateSubAccount
DeleteContact
DeleteSubaccount
GetAccountInfo
GetAccountPassword
GetAccountValidation
GetAllAccountInfo
GetCustomerPaymentInfo
GetOrderDetail
GetOrderList
GetReport
GetSubAccountDetails
GetSubaccountsDetailList
GetTransHistory
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
3/13/09 293
©2003-2009 Register.com, Inc. API commands: GetSubaccountsDetailList
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<SubAccountDetailList>
<SubAccount>
<LoginID />
<FName>john</FName>
<LName>doe</LName>
<EmailAddress>[email protected]</EmailAddress>
<OrganizationName>Partner Domains Inc.</OrganizationName>
<URL />
<JobTitle>Tester</JobTitle>
<Address1>111 Main St.</Address1>
<Address2 />
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>9995559999</Phone>
<Fax>9995559998</Fax>
<PhoneExt />
</SubAccount>
<SubAccount>
3/13/09 294
©2003-2009 Register.com, Inc. API commands: GetSubaccountsDetailList
<LoginID>giambi</LoginID>
<FName>John</FName>
<LName>Doe</LName>
<EmailAddress>[email protected]</EmailAddress>
<OrganizationName>Partner Domains Inc.</OrganizationName>
<URL />
<JobTitle>Tester</JobTitle>
<Address1>111 Main St.</Address1>
<Address2 />
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>9995559999</Phone>
<Fax>9995559998</Fax>
<PhoneExt />
</SubAccount>
.
.
.
<SubAccount>
<LoginID>testok</LoginID>
<FName>John</FName>
<LName>Doe</LName>
<EmailAddress>[email protected]</EmailAddress>
<OrganizationName>Partner Domains Inc.</OrganizationName>
<URL />
<JobTitle>Tester</JobTitle>
<Address1>111 Main St.</Address1>
<Address2 />
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>9995559999</Phone>
<Fax>9995559998</Fax>
<PhoneExt />
</SubAccount>
<SubAccounts>15</SubAccounts>
</SubAccountDetailList>
<Command>GETSUBACCOUNTSDETAILLIST</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 296
©2003-2009 Register.com, Inc. API commands: GetTLDList
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<tldlist>
<tld>
<tld>com</tld>
</tld>
<tld>
<tld>net</tld>
</tld>
<tld>
<tld>org</tld>
</tld>
<tld>
<tld>us</tld>
</tld>
<tld>
<tld>info</tld>
</tld>
<tld>
<tld>biz</tld>
</tld>
<tld>
<tld>co.uk</tld>
</tld>
<tld>
<tld>org.uk</tld>
</tld>
<tld>
<tld>de</tld>
</tld>
<tldcount>9</tldcount>
</tldlist>
<Command>GETTLDLIST</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
3/13/09 297
©2003-2009 Register.com, Inc. API commands: GetTLDList
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site />
<IsLockable />
<IsRealTimeTLD />
<ExecTime>0.140625</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
AuthorizeTLD
PE_SetPricing
RemoveTLD
SetResellerTLDPricing
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
3/13/09 299
©2003-2009 Register.com, Inc. API commands: GetTransHistory
3/13/09 300
©2003-2009 Register.com, Inc. API commands: GetTransHistory
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter
Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example
The following query requests the transaction history for account 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:
<?xml version="1.0" ?>
<interface-response>
<GetTransHistory>
<AdjustedBeginDate />
<AdjustedEndDate />
<FName>John</FName>
<LName>Doe</LName>
<PartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</PartyID>
<CurrentStartPosition>1</CurrentStartPosition>
<RecordCount>396</RecordCount>
<NewStartPosition>26</NewStartPosition>
<OldStartPosition>0</OldStartPosition>
<TransHistory>
<Transaction>
<Trans-Date>7/18/2007 1:25:11 PM</Trans-Date>
<Amount>-$4.40</Amount>
<TransDescription>Order</TransDescription>
<TransType>1</TransType>
<LinkValue>
OrderDetail.asp?OrderID=157385793&OrderProcess=Successful
</LinkValue>
<OrderID>157385793</OrderID>
<OrderProcessFlag>True</OrderProcessFlag>
3/13/09 301
©2003-2009 Register.com, Inc. API commands: GetTransHistory
<Balance>$7,028.39</Balance>
<ComBalance />
<TransStatus>Successful</TransStatus>
</Transaction>
<Transaction>
<Trans-Date>7/16/2007 2:05:01 AM</Trans-Date>
<Amount>-$8.95</Amount>
<TransDescription>Order</TransDescription>
<TransType>1</TransType>
<LinkValue>
OrderDetail.asp?OrderID=157385407&OrderProcess=Successful
</LinkValue>
<OrderID>157385407</OrderID>
<OrderProcessFlag>True</OrderProcessFlag>
<Balance>$7,032.79</Balance>
<ComBalance />
<TransStatus>Successful</TransStatus>
</Transaction>
.
.
.
</TransHistory>
</GetTransHistory>
<Command>GETTRANSHISTORY</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.750</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
CheckLogin
CreateAccount
CreateSubAccount
GetAccountInfo
GetAccountPassword
GetAllAccountInfo
GetOrderDetail
GetOrderList
GetReport
GetSubAccountDetails
GetSubAccounts
RefillAccount
RPT_GetReport
UpdateAccountInfo
UpdateCusPreferences
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
3/13/09 303
©2003-2009 Register.com, Inc. API commands: GetWhoisContact
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<GetWhoisContacts>
3/13/09 304
©2003-2009 Register.com, Inc. API commands: GetWhoisContact
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
3/13/09 306
©2003-2009 Register.com, Inc. API commands: GetWPPSInfo
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetWPPSInfo>
<domainname sld="partnerdomain" tld="com" domainnameid="152533676">
partnerdomain.com
</domainname>
<WPPSAllowed>1</WPPSAllowed>
<WPPSExists>1</WPPSExists>
<WPPSEnabled>1</WPPSEnabled>
<WPPSExpDate>Nov 26, 2004</WPPSExpDate>
3/13/09 307
©2003-2009 Register.com, Inc. API commands: GetWPPSInfo
<WPPSAutoRenew>No</WPPSAutoRenew>
<WPPSPrice>$6.00</WPPSPrice>
<contacts>
<contact ContactType="Administrative">
<Organization>Partner Domains Inc.</Organization>
<FName>John</FName>
<LName>Doe</LName>
<Address1>111 Main St.</Address1>
<Address2 />
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>+1.5555555555</Phone>
<Fax>+1.5555555556</Fax>
<EmailAddress>[email protected]</EmailAddress>
</contact>
.
.
.
<contact ContactType="WPPS">
<Organization>Whois Privacy Protection Service, Inc.</Organization>
<FName>Whois</FName>
<LName>Agent</LName>
<Address1>PMB 368, 14150 NE 20th St - F1</Address1>
<Address2>C/O partnerdomain.com</Address2>
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>+1.4252740657</Phone>
<Fax>+1.4256960234</Fax>
<EmailAddress>[email protected]</EmailAddress>
</contact>
</contacts>
</GetWPPSInfo>
<Command>GETWPPSINFO</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<ExecTime>0.140625</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 309
©2003-2009 Register.com, Inc. API commands: HE_CancelAccount
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<AccountStatus>1</AccountStatus>
<cancel>True</cancel>
<success>true</success>
3/13/09 310
©2003-2009 Register.com, Inc. API commands: HE_CancelAccount
<Command>HE_CANCELACCOUNT</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.391</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
HE_ChangePassword
HE_CreateAccount
HE_GetAccountDetails
HE_GetAccounts
HE_GetPricing
HE_UpgradeAccount
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
3/13/09 312
©2003-2009 Register.com, Inc. API commands: HE_ChangePassword
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<AccountStatus>0</AccountStatus>
<success>True</success>
<Command>HE_CHANGEPASSWORD</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.469</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
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
3/13/09 315
©2003-2009 Register.com, Inc. API commands: HE_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.
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:
<?xml version="1.0" ?>
<interface-response>
<Mailboxes>7</Mailboxes>
<BlackBerrys>3</BlackBerrys>
<GoodLinks>2</GoodLinks>
<ActiveSyncs>1</ActiveSyncs>
<ExtraStorage>6</ExtraStorage>
<TotalPrice>363</TotalPrice>
<SMTPProxy>smtp14.msoutlookonline.net</SMTPProxy>
<HostedExchangeID>1234567</HostedExchageID>
<HostedExchangeLoginID>HX01234</HostedExchangeLoginID>
<HostedExchangePassword>F13EC56</HostedExchangePassword>
<OrderID>102534897</OrderID>
<Success>True</Success>
<Command>HE_CREATEACCOUNT</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.766</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
HE_CancelAccount
HE_ChangePassword
HE_GetAccountDetails
HE_GetAccounts
HE_GetPricing
HE_UpgradeAccount
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
3/13/09 318
©2003-2009 Register.com, Inc. API commands: HE_GetAccountDetails
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<Account>
<HostedExchangeID>24</HostedExchangeID>
<AccountID>1056747</AccountID>
3/13/09 319
©2003-2009 Register.com, Inc. API commands: HE_GetAccountDetails
<loginid>HX57904</loginid>
<password>3932293</password>
<SignupDate>1/8/2007 9:33:13 AM</SignupDate>
<TerminateDate />
<Terminate>False</Terminate>
<status>1</status>
<Plan>MSExchange_PLR (Gold) Copy</Plan>
<MailBoxes>100</MailBoxes>
<BlackBerry>2</BlackBerry>
<GoodLink>2</GoodLink>
<ActiveSync>2</ActiveSync>
<ExtraStorage>2</ExtraStorage>
<BillCycleID>1</BillCycleID>
<SMTPProxy>smtp14.msoutlookonline.net</SMTPProxy>
<NextBillingDate>2/8/2007</NextBillingDate>
<NextBillingPeriod>1</NextBillingPeriod>
<CurrentBillingPeriod>1</CurrentBillingPeriod>
<BillingAmount>870</BillingAmount>
</Account>
<Command>HE_GETACCOUNTDETAILS</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.094</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
HE_CancelAccount
HE_ChangePassword
HE_CreateAccount
HE_GetAccounts
HE_GetPricing
HE_UpgradeAccount
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
3/13/09 321
©2003-2009 Register.com, Inc. API commands: HE_GetAccounts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<ExchangeAccounts>
<Account>
<LoginID>HX60270</LoginID>
<Password>6DF9968</Password>
<SignupDate>1/17/2007 5:55:39 PM</SignupDate>
<TerminateDate />
<Terminate>False</Terminate>
<Status>1</Status>
<Plan>MSExchange_PLR (Gold) Copy</Plan>
<Mailboxes>1</Mailboxes>
<Blackberry>1</Blackberry>
<goodlink>1</goodlink>
<Activesync>1</Activesync>
3/13/09 322
©2003-2009 Register.com, Inc. API commands: HE_GetAccounts
<Extrastorage>1</Extrastorage>
<BillcycleID>1</BillcycleID>
<SMTPProxy>smtp14.msoutlookonline.net</SMTPProxy>
<NextBillingDate>2/17/2007</NextBillingDate>
</Account>
<Account>
<LoginID>HX04967</LoginID>
<Password>C2EA47A</Password>
<SignupDate>1/23/2007 5:26:26 PM</SignupDate>
<TerminateDate />
<Terminate>False</Terminate>
<Status>1</Status>
<Plan>MSExchange_PLR (Gold) Copy</Plan>
<Mailboxes>1</Mailboxes>
<Blackberry>2</Blackberry>
<goodlink>3</goodlink>
<Activesync>4</Activesync>
<Extrastorage>1</Extrastorage>
<BillcycleID>1</BillcycleID>
<SMTPProxy>smtp14.msoutlookonline.net</SMTPProxy>
<NextBillingDate>2/23/2007</NextBillingDate>
</Account>
.
.
.
</ExchangeAccounts>
<Count>8</Count>
<Command>HE_GETACCOUNTS</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.172</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
HE_CancelAccount
HE_ChangePassword
HE_CreateAccount
HE_GetAccountDetails
HE_GetPricing
HE_UpgradeAccount
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
3/13/09 324
©2003-2009 Register.com, Inc. API commands: HE_GetPricing
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<MailBoxes>
<MailBox>
<QTY>1</QTY>
<Price>8.5</Price>
</MailBox>
<MailBox>
<QTY>3</QTY>
<Price>8</Price>
</MailBox>
<MailBox>
<QTY>5</QTY>
<Price>8</Price>
</MailBox>
<MailBox>
<QTY>10</QTY>
<Price>8</Price>
</MailBox>
<MailBox>
<QTY>25</QTY>
<Price>8</Price>
</MailBox>
<MailBox>
<QTY>50</QTY>
<Price>8</Price>
</MailBox>
3/13/09 325
©2003-2009 Register.com, Inc. API commands: HE_GetPricing
<MailBox>
<QTY>100</QTY>
<Price>8</Price>
</MailBox>
</MailBoxes>
<Addons>
<AdditionalStorage>5</AdditionalStorage>
<Blackberry>9</Blackberry>
<Goodlink>19</Goodlink>
<ActiveSync>2</ActiveSync>
</Addons>
<SetupFees>
<BlackberrySetup>50</BlackberrySetup>
<GoodlinkSetup>30</GoodlinkSetup>
</SetupFees>
<Command>HE_GETPRICING</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.344</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
HE_CancelAccount
HE_ChangePassword
HE_CreateAccount
HE_GetAccountDetails
HE_GetAccounts
HE_UpgradeAccount
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
3/13/09 327
©2003-2009 Register.com, Inc. API commands: HE_UpgradeAccount
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:
<?xml version="1.0" ?>
<interface-response>
<AccountStatus>0</AccountStatus>
<upgraded>true</upgraded>
<success>True</success>
<Command>HE_UPGRADEACCOUNT</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>1.063</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
HE_CancelAccount
HE_ChangePassword
HE_CreateAccount
HE_GetAccountDetails
HE_GetAccounts
HE_GetPricing
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
3/13/09 330
©2003-2009 Register.com, Inc. API commands: InsertNewOrder
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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
<?xml version="1.0" ?>
<interface-response>
<OrderID>156062745</OrderID>
<ProdType10>10</ProdType10>
<Command>INSERTNEWORDER</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 333
©2003-2009 Register.com, Inc. API commands: ModifyNS
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<reg-lock>1</reg-lock>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
3/13/09 334
©2003-2009 Register.com, Inc. API commands: ModifyNS
<Command>MODIFYNS</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 336
©2003-2009 Register.com, Inc. API commands: ModifyNSHosting
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
- <interface-response>
<RegistrarHold>False</RegistrarHold>
<Command>MODIFYNSHOSTING</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
- <debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 338
©2003-2009 Register.com, Inc. API commands: ModifyPOP3
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
3/13/09 339
©2003-2009 Register.com, Inc. API commands: ModifyPOP3
<RegistrarHold>False</RegistrarHold>
<Command>MODIFYPOP3</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 341
©2003-2009 Register.com, Inc. API commands: NameSpinner
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:
<?xml version="1.0" ?>
<interface-response>
<namespin>
<spincount>8</spincount>
<TLDList />
<domains>
<domain name="handsewncurtains" com="n" comscore="835" net="y" netscore="864"
tv="y" tvscore="797" cc="y" ccscore="762" />
<domain name="handicappingclub" com="n" comscore="821" net="y" netscore="851"
tv="y" tvscore="784" cc="y" ccscore="749" />
<domain name="handingok" com="y" comscore="837" net="y" netscore="810"
tv="y" tvscore="783" cc="y" ccscore="757" />
<domain name="handsofjustice" com="n" comscore="870" net="n" netscore="844"
tv="y" tvscore="834" cc="y" ccscore="799" />
<domain name="handoki" com="n" comscore="794" net="y" netscore="824"
tv="y" tvscore="757" cc="y" ccscore="722" />
<domain name="handinghand" com="y" comscore="820" net="y" netscore="793"
tv="y" tvscore="767" cc="y" ccscore="740" />
<domain name="handcrafthouselogs" com="y" comscore="810" net="y" netscore="783"
tv="y" tvscore="757" cc="y" ccscore="730" />
<domain name="handloser" com="n" comscore="844" net="n" netscore="817"
tv="y" tvscore="807" cc="y" ccscore="773" />
</domains>
</namespin>
<originalsld>hand</originalsld>
<Command>NAMESPINNER</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.719</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
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
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:
<?xml version="1.0" ?>
<interface-response>
<ParseDomain>
<Host>www</Host>
<SLD>partnerdomain</SLD>
<TLD>com</TLD>
</ParseDomain>
<Command>PARSEDOMAIN</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 347
©2003-2009 Register.com, Inc. API commands: PE_GetCustomerPricing
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:
<?xml version="1.0" ?>
<interface-response>
<productstructure>
<product>
<cpid>256759</cpid>
<producttype>19</producttype>
<productdescription>Transfer</productdescription>
<tldid>2</tldid>
<tld>org</tld>
<retailprice />
<resellerprice>10.00</resellerprice>
<enabled>True</enabled>
</product>
</productstructure>
<Command>PE_GETCUSTOMERPRICING</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
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:
<?xml version="1.0" ?>
<interface-response>
<pricestructure>
<product>
<tld>com</tld>
<registerprice>10.00</registerprice>
<registerenabled>True</registerenabled>
<renewprice>10.00</renewprice>
<renewenabled>True</renewenabled>
<transferprice>10.00</transferprice>
<transferenabled>True</transferenabled>
</product>
<product>
<tld>net</tld>
<registerprice>10.00</registerprice>
<registerenabled>True</registerenabled>
<renewprice>10.00</renewprice>
<renewenabled>True</renewenabled>
<transferprice>10.00</transferprice>
<transferenabled>True</transferenabled>
</product>
<product>
<tld>org</tld>
<registerprice>10.00</registerprice>
<registerenabled>True</registerenabled>
<renewprice>10.00</renewprice>
<renewenabled>True</renewenabled>
<transferprice>10.00</transferprice>
<transferenabled>True</transferenabled>
</product>
.
.
.
</pricestructure>
<Command>PE_GETDOMAINPRICING</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
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:
<?xml version="1.0" ?>
<interface-response>
<pricing>
<pop>18.4015</pop>
</pricing>
<Command>PE_GETPOPPRICE</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>8.203125E-02</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
GetPOP3
PE_GetCustomerPricing
PE_GetDomainPricing
PE_GetProductPrice
PE_GetResellerPrice
PE_GetRetailPrice
PE_GetRetailPricing
PE_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
3/13/09 355
©2003-2009 Register.com, Inc. API commands: PE_GetProductPrice
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:
<?xml version="1.0" ?>
<interface-response>
<productprice>
<price>8.95</price>
<productenabled>True</productenabled>
</productprice>
<Command>PE_GETPRODUCTPRICE</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.1015625</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
PE_GetCustomerPricing
PE_GetDomainPricing
PE_GetPOPPrice
PE_GetResellerPrice
PE_GetRetailPrice
PE_GetRetailPricing
PE_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
3/13/09 358
©2003-2009 Register.com, Inc. API commands: PE_GetResellerPrice
3/13/09 359
©2003-2009 Register.com, Inc. API commands: PE_GetResellerPrice
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<productprice>
<price>10.00</price>
<productenabled>True</productenabled>
</productprice>
<Command>PE_GETRESELLERPRICE</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 361
©2003-2009 Register.com, Inc. API commands: PE_GetRetailPrice
3/13/09 362
©2003-2009 Register.com, Inc. API commands: PE_GetRetailPrice
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<productprice>
<price>29.95</price>
<productenabled>True</productenabled>
</productprice>
<Command>PE_GETRETAILPRICE</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 364
©2003-2009 Register.com, Inc. API commands: PE_GetRetailPricing
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:
<?xml version="1.0" ?>
<interface-response>
<pricestructure>
<tld>
<tld>com</tld>
<tldid>0</tldid>
<minimumregistration>1</minimumregistration>
<registerprice>29.95</registerprice>
<registerenabled>True</registerenabled>
<renewprice>29.95</renewprice>
<renewenabled>True</renewenabled>
<transferprice>29.95</transferprice>
<transferenabled>True</transferenabled>
</tld>
<tld>
<tld>net</tld>
<tldid>1</tldid>
<minimumregistration>1</minimumregistration>
<registerprice>29.95</registerprice>
<registerenabled>True</registerenabled>
<renewprice>29.95</renewprice>
<renewenabled>True</renewenabled>
<transferprice>29.95</transferprice>
<transferenabled>True</transferenabled>
</tld>
.
.
.
<product>
<price>29.95</price>
<productenabled>True</productenabled>
<producttype>45</producttype>
</product>
<product>
<price>29.95</price>
<productenabled>True</productenabled>
<producttype>47</producttype>
</product>
</pricestructure>
<Command>PE_GETRETAILPRICING</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>0</IsLockable>
3/13/09 366
©2003-2009 Register.com, Inc. API commands: PE_GetRetailPricing
<IsRealTimeTLD>0</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
PE_GetCustomerPricing
PE_GetDomainPricing
PE_GetResellerPrice
PE_GetDomainPricing
PE_GetPOPPrice
PE_GetProductPrice
PE_GetResellerPrice
PE_GetRetailPrice
PE_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
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:
<?xml version="1.0" ?>
<interface-response>
<productid>
<tldid>2</tldid>
</productid>
<Command>PE_GETTLDID</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+07.00</TimeDifference>
<ExecTime>0.1015625</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
PE_SetPricing
SetResellerTLDPricing
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
3/13/09 370
©2003-2009 Register.com, Inc. API commands: PE_SetPricing
(see adjacent
rows for other
ProductTypes)
ProductTypeX Required Product type. Permitted values are: 63
X=1, 2, 3, . . . 35 Additional storage for POP pak - renewal - 512MB/box
36 Additional storage for POP pak - 512MB per mailbox
Email services in 38 POP mail 10-pak
this row 39 POP mail 10-pak renewal
41 Registration and email forwarding by the .name
(see adjacent Registry
rows for other 42 Email forwarding by the .name Registry
ProductTypes) 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
3/13/09 371
©2003-2009 Register.com, Inc. API commands: PE_SetPricing
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<Count>2</Count>
<Status>Successful</Status>
<Command>PE_SETPRICING</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 374
©2003-2009 Register.com, Inc. API commands: Preconfigure
3/13/09 375
©2003-2009 Register.com, Inc. API commands: Preconfigure
3/13/09 376
©2003-2009 Register.com, Inc. API commands: Preconfigure
3/13/09 377
©2003-2009 Register.com, Inc. API commands: Preconfigure
Notes
• A fully qualified domain name is expressed in the format “hostname.SLD.TLD.”. Note that the period at the
end is an essential component of a fully qualified domain name.
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter
Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
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:
<?xml version="1.0" ?>
<interface-response>
<PreConfigBillingInfo>
<BillingOrganizationName>Partner Domains Inc.</BillingOrganizationName>
<BillingJobTitle>President</BillingJobTitle>
<BillingFirstName>John</BillingFirstName>
<BillingLastName>Doe</BillingLastName>
<BillingAddress1>111 Main St.</BillingAddress1>
<BillingAddress2 />
<BillingCity>Hometown</BillingCity>
<BillingStateProvince>NY</BillingStateProvince>
<BillingStateProvinceChoice>S</BillingStateProvinceChoice>
<BillingPostalCode>99999</BillingPostalCode>
<BillingCountry>United States</BillingCountry>
<BillingPhone>5555555555</BillingPhone>
<BillingFax>5555555556</BillingFax>
<BillingEmailAddress>[email protected]</BillingEmailAddress>
</PreConfigBillingInfo>
<PreConfigSuccess>2</PreConfigSuccess>
.
.
.
<Command>PRECONFIGURE</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>False</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 380
©2003-2009 Register.com, Inc. API commands: Purchase
3/13/09 381
©2003-2009 Register.com, Inc. API commands: Purchase
3/13/09 382
©2003-2009 Register.com, Inc. API commands: Purchase
3/13/09 383
©2003-2009 Register.com, Inc. API commands: Purchase
3/13/09 384
©2003-2009 Register.com, Inc. API commands: Purchase
3/13/09 385
©2003-2009 Register.com, Inc. API commands: Purchase
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 non-
real-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&Registrant-
Phone=+1.5555555555&
RegistrantFax=+1.5555555556&ResponseType=XML
The response includes the three components that indicate a successful transaction: an order ID indicates success
at the registrar level, and the RRPCode value of 200 and RRP text with a success message indicate success at
the Registry level:
<?xml version="1.0" ?>
<interface-response>
<OrderID>156094996</OrderID>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully - 156094996</RRPText>
<Command>PURCHASE</Command>
3/13/09 387
©2003-2009 Register.com, Inc. API commands: Purchase
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 389
©2003-2009 Register.com, Inc. API commands: PurchaseHosting
3/13/09 390
©2003-2009 Register.com, Inc. API commands: PurchaseHosting
3/13/09 391
©2003-2009 Register.com, Inc. API commands: PurchaseHosting
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<OrderID>156062635</OrderID>
<Command>PURCHASEHOSTING</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 393
©2003-2009 Register.com, Inc. API commands: PurchasePOPBundle
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<orderid>156133590</orderid>
<bundleid>5134</bundleid>
<Command>PURCHASEPOPBUNDLE</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 396
©2003-2009 Register.com, Inc. API commands: PurchasePreview
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 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:
<?xml version="1.0" ?>
<interface-response>
<Purchase-Summary>
<Reseller>True</Reseller>
<Balance>3627.65</Balance>
<AvailableBalance>3587.85</AvailableBalance>
<DomainCount>1</DomainCount>
<DotComPrice>10.00</DotComPrice>
<DotNetPrice>10.00</DotNetPrice>
<DotOrgPrice>10.00</DotOrgPrice>
<DotCcPrice>24.95</DotCcPrice>
<DotTvPrice>39.95</DotTvPrice>
<CartItem>
<ItemID>365635</ItemID>
<Description>Register</Description>
<Years>2</Years>
<NameID>152534050</NameID>
<Name>partnerdomain.com</Name>
<StatusID>A</StatusID>
<ItemPrice>10.00</ItemPrice>
<ExtPrice>20.00</ExtPrice>
<NeedsConfig />
</CartItem>
<TotalPrice>20.00</TotalPrice>
</Purchase-Summary>
<Command>PURCHASEPREVIEW</Command>
<ErrCount>0</ErrCount>
3/13/09 397
©2003-2009 Register.com, Inc. API commands: PurchasePreview
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 399
©2003-2009 Register.com, Inc. API commands: PurchaseServices
3/13/09 400
©2003-2009 Register.com, Inc. API commands: PurchaseServices
3/13/09 401
©2003-2009 Register.com, Inc. API commands: PurchaseServices
3/13/09 402
©2003-2009 Register.com, Inc. API commands: PurchaseServices
3/13/09 403
©2003-2009 Register.com, Inc. API commands: PurchaseServices
3/13/09 404
©2003-2009 Register.com, Inc. API commands: PurchaseServices
3/13/09 405
©2003-2009 Register.com, Inc. API commands: PurchaseServices
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<orderid>156272481</orderid>
<Bundles>
<BundleID>8069</BundleID>
<BundleID>8070</BundleID>
<BundleID>8071</BundleID>
</Bundles>
<BundleCount>3</BundleCount>
<Command>PURCHASESERVICES</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.5429688</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 408
©2003-2009 Register.com, Inc. API commands: PushDomain
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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&response-
type=xml
The response is as follows:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<Push>
<domainname sld="partnerdomain2" tld="net" id="152533887">
partnerdomain2.net
</domainname>
<PushDomain>1</PushDomain>
</Push>
<Command>PUSHDOMAIN</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 411
©2003-2009 Register.com, Inc. API commands: RefillAccount
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:
<?xml version="1.0" ?>
<interface-response>
<CurrentDate>Wednesday, August 20, 2007</CurrentDate>
<RefillAccount>
<FName>John</FName>
<LName>Doe</LName>
<Reseller>1</Reseller>
<CCTRANSRESULT>APPROVED</CCTRANSRESULT>
<ResellerRefill>Transactions processed successfully.</ResellerRefill>
<CreditCardStatus>Successful</CreditCardStatus>
<CCYear>2004</CCYear>
<CCMonth>2</CCMonth>
<CCNumber>************5215</CCNumber>
<CCName>JohnDoe</CCName>
<PaymentType>MasterCard</PaymentType>
<CCAddress>100 Main St.</CCAddress>
<CCCity>Hometown</CCCity>
<CCStateProvince>NY</CCStateProvince>
<CCCountry>us</CCCountry>
<CCPhoneDial />
<CCPhone>5555559999</CCPhone>
<CCZip>99999</CCZip>
</RefillAccount>
<Command>REFILLACCOUNT</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>0</IsLockable>
<IsRealTimeTLD>0</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 415
©2003-2009 Register.com, Inc. API commands: RegisterNameServer
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegisterNameserver>
<NS>dns1.partnerdomain.com</NS>
<IP>127.0.0.1</IP>
<reg-lock>1</reg-lock>
<RegistrarLock>ACTIVE</RegistrarLock>
<NsSuccess>1</NsSuccess>
<RegistrarLock>REGISTRAR-LOCK</RegistrarLock>
</RegisterNameserver>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
<Command>REGISTERNAMESERVER</Command>
<ErrCount>0</ErrCount>
<Server>TestServer</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 418
©2003-2009 Register.com, Inc. API commands: RemoveTLD
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<tldlist>
<deletetld>us</deletetld>
<deletetld>ca</deletetld>
</tldlist>
<Command>REMOVETLD</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<ExecTime>1.191406</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 421
©2003-2009 Register.com, Inc. API commands: RenewPOPBundle
3/13/09 422
©2003-2009 Register.com, Inc. API commands: RenewPOPBundle
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<orderid>156227365</orderid>
<Command>RENEWPOPBUNDLE</Command>
3/13/09 423
©2003-2009 Register.com, Inc. API commands: RenewPOPBundle
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<ExecTime>0.34375</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
Extend
GetPOP3
GetPOPExpirations
GetRenew
Purchase
PurchasePOPBundle
RenewServices
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
3/13/09 425
©2003-2009 Register.com, Inc. API commands: RenewServices
3/13/09 426
©2003-2009 Register.com, Inc. API commands: RenewServices
3/13/09 427
©2003-2009 Register.com, Inc. API commands: RenewServices
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<OrderID>157405437</OrderID>
<Command>RENEWSERVICES</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+08.00</TimeDifference>
<ExecTime>0.797</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
PurchaseServices
RenewPOPBundle
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
3/13/09 429
©2003-2009 Register.com, Inc. API commands: RPT_GetReport
3/13/09 430
©2003-2009 Register.com, Inc. API commands: RPT_GetReport
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<rpt>
<rptString>Registrations | Renewals | Transfers In | Private Label | Sub-Accounts |
Accounting | Expiring Domains | | | | Pricing Editor Updates | Transfers Out | |
</rptString>
<threemopast>10/01/2009</threemopast>
3/13/09 431
©2003-2009 Register.com, Inc. API commands: RPT_GetReport
<sixmopast>07/01/2009</sixmopast>
<begindate>12/01/2009</begindate>
<enddate>01/01/2010</enddate>
<option>
<reporttype id="0" name="Registrations" />
<reporttype id="1" name="Renewals" />
<reporttype id="2" name="Transfers" />
<reporttype id="3" name="Private Label" />
<reporttype id="4" name="Sub-Accounts" />
<reporttype id="5" name="Accounting" />
<reporttype id="6" name="Expiring Names" />
<reporttype id="7" name="Auction History" />
<reporttype id="8" name="Auction Payment Pending" />
</option>
<reporttype>0</reporttype>
<reportname>Registrations</reportname>
<results>
<QueueReportResults>0</QueueReportResults>
<root>
<tlds>
<tld TLD="com" NumDomains="300" AvgRegistration="1.00" />
<tld TLD="net" NumDomains="28" AvgRegistration="1.00" />
<tld TLD="mobi" NumDomains="24" AvgRegistration="2.13" />
<tld TLD="org" NumDomains="7" AvgRegistration="1.00" />
<tld TLD="biz" NumDomains="5" AvgRegistration="1.00" />
<tld TLD="info" NumDomains="4" AvgRegistration="1.00" />
<tld TLD="kids.us" NumDomains="1" AvgRegistration="1.00" />
<tld TLD="ca" NumDomains="1" AvgRegistration="1.00" />
<tld TLD="cc" NumDomains="1" AvgRegistration="1.00" />
<tld TLD="tv" NumDomains="1" AvgRegistration="1.00" />
<tld TLD="us" NumDomains="1" AvgRegistration="1.00" />
<tld TLD="us.com" NumDomains="1" AvgRegistration="1.00" />
<tld TLD="asia" NumDomains="1" AvgRegistration="1.00" />
</tlds>
<orders>
<order OrderID="156189763" SLD="fgs456" TLD="com"
CreationDate="2009-12-31T06:29:37.607" ExpDate="2009-12-31T09:29:32"
PaidAmount="8.9500" BilledToCust="0.0000" />
<row OrderID="156189777" SLD="sdifuf" TLD="com"
CreationDate="2010-01-01T08:43:52.077" ExpDate="2011-01-01T11:43:47"
PaidAmount="8.9500" BilledToCust="0.0000" />
</orders>
</root>
<NewThisMonth>375</NewThisMonth>
<AverageRegPeriod>1.072000</AverageRegPeriod>
<NewStartPosition>52</NewStartPosition>
<ThisStartPosition>1</ThisStartPosition>
<ThisEndPosition>51</ThisEndPosition>
<PreviousStartPosition />
<TotalReturned>51</TotalReturned>
<TotalRows>375</TotalRows>
<ShowPrevious>0</ShowPrevious>
<ShowNext>True</ShowNext>
<ShowPaging>True</ShowPaging>
<Version>1</Version>
</results>
</rpt>
<Command>RPT_GETREPORT</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
3/13/09 432
©2003-2009 Register.com, Inc. API commands: RPT_GetReport
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<ExecTime>0.8125</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
CreateAccount
CreateSubAccount
GetAccountInfo
GetAccountPassword
GetAllAccountInfo
GetOrderDetail
GetOrderList
GetReport
GetSubAccounts
GetTransHistory
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
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:
<interface-response>
<Command>SENDACCOUNTEMAIL</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod/>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable/>
<IsRealTimeTLD/>
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.078125</ExecTime>
<Done>true</Done>
<debug></debug>
</interface-response>
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
3/13/09 436
©2003-2009 Register.com, Inc. API commands: ServiceSelect
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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):
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<ServiceSelect>
<domainname sld="partnerdomain" tld="com" domainnameid="152533676">
partnerdomain.com
</domainname>
<service name="email">
<UpdateOption>True</UpdateOption>
<option name="1048" />
<option name="1114" />
</service>
<current-svc>1114</current-svc>
<WebSite />
</ServiceSelect>
<Command>SERVICESELECT</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 439
©2003-2009 Register.com, Inc. API commands: SetCatchAll
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<CatchAll>[email protected]</CatchAll>
<Command>SETCATCHALL</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.09375</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
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
3/13/09 442
©2003-2009 Register.com, Inc. API commands: SetCustomerDefinedData
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<Command>SETCUSTOMERDEFINEDDATA</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 445
©2003-2009 Register.com, Inc. API commands: SetDNSHost
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Command>SETDNSHOST</Command>
<ErrCount>0</ErrCount>
<Server>Reseller5</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 447
©2003-2009 Register.com, Inc. API commands: SetDomainSRVHosts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<InsertedCount>1</InsertedCount>
<UpdatedCount>0</UpdatedCount>
<DeletedCount>0</DeletedCount>
<Success>true</Success>
<Command>SETDOMAINSRVHOSTS</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.078</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
GetDomainInfo
GetDomainSRVHosts
GetHosts
SetHosts
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
3/13/09 450
©2003-2009 Register.com, Inc. API commands: SetDomainSubServices
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<DomainServices>
<EmailForwarding>1</EmailForwarding>
<HostRecords>1</HostRecords>
<SetDomainServices>Successful</SetDomainServices>
</DomainServices>
<Command>SETDOMAINSUBSERVICES</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 453
©2003-2009 Register.com, Inc. API commands: SetDotNameForwarding
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<dotnameforwarding>
<ForwardTo>[email protected]</ForwardTo>
</dotnameforwarding>
<Command>SETDOTNAMEFORWARDING</Command>
<ErrCount>0</ErrCount>
<Server>Reseller3</Server>
<Site>rcom</Site>
<IsLockable>False</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 455
©2003-2009 Register.com, Inc. API commands: SetHosts
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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Command>SETHOSTS</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 458
©2003-2009 Register.com, Inc. API commands: SetPakRenew
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<PakUpdated>5105</PakUpdated>
<AutoPakRenew>1</AutoPakRenew>
<Command>SETPAKRENEW</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 460
©2003-2009 Register.com, Inc. API commands: SetPassword
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<Command>SETPASSWORD</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 462
©2003-2009 Register.com, Inc. API commands: SetPOPForwarding
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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&[email protected]&
Enable=1&StatusFlags=1&ResponseType=xml
In the response, the Success value 1 indicates that the query was successful:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<success>1</success>
<Command>SETPOPFORWARDING</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
3/13/09 463
©2003-2009 Register.com, Inc. API commands: SetPOPForwarding
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.1328125</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
DeletePOP3
GetCatchAll
GetPOP3
GetPOPForwarding
PurchasePOPBundle
SetUpPOP3User
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
3/13/09 465
©2003-2009 Register.com, Inc. API commands: SetRegLock
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<RegistrarLock>REGISTRAR-LOCK</RegistrarLock>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
<Command>SETREGLOCK</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 468
©2003-2009 Register.com, Inc. API commands: SetRenew
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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):
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<RenewName>1</RenewName>
<Command>SETRENEW</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
3/13/09 469
©2003-2009 Register.com, Inc. API commands: SetRenew
</debug>
</interface-response>
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
3/13/09 471
©2003-2009 Register.com, Inc. API commands: SetResellerServicesPricing
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<services>
<service name="pop3" price="19.95" />
<service name="dotnamebundle" price="" />
</services>
<servicescount>2</servicescount>
<Command>SETRESELLERSERVICESPRICING</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
3/13/09 472
©2003-2009 Register.com, Inc. API commands: SetResellerServicesPricing
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<IsLockable>0</IsLockable>
<IsRealTimeTLD>0</IsRealTimeTLD>
<ExecTime>0.6875</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
GetSubAccounts
PE_SetPricing
SetResellerTLDPricing
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
3/13/09 474
©2003-2009 Register.com, Inc. API commands: SetResellerTLDPricing
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<tlds>
<price tld="biz" id="6" prod="10" />
<price tld="biz" id="6" prod="16" />
<price tld="biz" id="6" prod="19" />
<price tld="com" id="0" prod="10">12.95</price>
<price tld="com" id="0" prod="16">12.95</price>
<price tld="com" id="0" prod="19">12.95</price>
<price tld="info" id="5" prod="10" />
<price tld="info" id="5" prod="16" />
<price tld="info" id="5" prod="19" />
<price tld="net" id="1" prod="10">12.95</price>
<price tld="net" id="1" prod="16">12.95</price>
<price tld="net" id="1" prod="19">12.95</price>
<price tld="org" id="2" prod="10">12.95</price>
<price tld="org" id="2" prod="16">12.95</price>
<price tld="org" id="2" prod="19">12.95</price>
</tlds>
<tldcount>15</tldcount>
<services>
<service name="dotnamebundle" price="" />
</services>
<servicescount>3</servicescount>
<Command>SETRESELLERTLDPRICING</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site />
<IsLockable>False</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<ExecTime>1.492188</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 477
©2003-2009 Register.com, Inc. API commands: SetSPFHosts
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<Command>SETSPFHOSTS</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
3/13/09 478
©2003-2009 Register.com, Inc. API commands: SetSPFHosts
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.2382813</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
GetHosts
GetSPFHosts
SetHosts
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
3/13/09 480
©2003-2009 Register.com, Inc. API commands: SetUpPOP3User
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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&POPUser-
Name=james&
POPPassword=rcompartnerpw&POPFullName=James+Doe&responsetype=xml
In the response, the value 0 for parameter ErrCount indicates that the query was successful:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<Command>SETUPPOP3USER</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
3/13/09 481
©2003-2009 Register.com, Inc. API commands: SetUpPOP3User
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
DeleteAllPOPPaks
DeletePOP3
DeletePOPPak
Forwarding
GetCatchAll
GetDotNameForwarding
GetForwarding
GetMailHosts
GetPOP3
GetPOPForwarding
ModifyPOP3
PurchasePOPBundle
SetDotNameForwarding
SetUpPOP3User
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
3/13/09 483
©2003-2009 Register.com, Inc. API commands: StatusDomain
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainStatus>
<DomainName>partnerdomain.com</DomainName>
<Registrar>Known</Registrar>
<InAccount>1</InAccount>
<ExpDate>6/25/2012 4:20:24 PM</ExpDate>
<OrderID>156062089</OrderID>
</DomainStatus>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
<Command>STATUSDOMAIN</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 486
©2003-2009 Register.com, Inc. API commands: SubAccountDomains
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<GetDomains>
<tab>iown</tab>
<multirrp>False</multirrp>
<domain-list type="Registered">
<domain>
<DomainNameID>152556719</DomainNameID>
<sld>subpartnerdomain</sld>
<tld>com</tld>
<ns-status>NA</ns-status>
<expiration-date>8/2/2006</expiration-date>
<auto-renew>Yes</auto-renew>
</domain>
3/13/09 487
©2003-2009 Register.com, Inc. API commands: SubAccountDomains
<domain>
<DomainNameID>152556721</DomainNameID>
<sld>subpartnerdomain2</sld>
<tld>net</tld>
<ns-status>NA</ns-status>
<expiration-date>8/2/2006</expiration-date>
<auto-renew>Yes</auto-renew>
</domain>
<domain>
<DomainNameID>152556722</DomainNameID>
<sld>subpartnerdomain3</sld>
<tld>info</tld>
<ns-status>NA</ns-status>
<expiration-date>8/2/2006</expiration-date>
<auto-renew>Yes</auto-renew>
</domain>
</domain-list>
<EndPosition>3</EndPosition>
<PreviousRecords>0</PreviousRecords>
<NextRecords>0</NextRecords>
<OrderBy />
<Result>True</Result>
<StartPosition>1</StartPosition>
<DomainCount>3</DomainCount>
<TotalDomainCount>225</TotalDomainCount>
<StartLetter />
</GetDomains>
<Command>SUBACCOUNTDOMAINS</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>e</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.2109375</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
CreateAccount
CreateSubAccount
GetSubAccountDetails
GetSubAccountPassword
GetSubAccounts
GetSubaccountsDetailList
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
3/13/09 489
©2003-2009 Register.com, Inc. API commands: SynchAuthInfo
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<EPPEmailMessage>Email has been sent.</EPPEmailMessage>
<Command>SYNCHAUTHINFO</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLER1-STG</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>1.715</ExecTime>
<Done>true</Done>
<debug><![CDATA[ ]]></debug>
</interface-response>
Related commands
TP_CreateOrder
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
3/13/09 491
©2003-2009 Register.com, Inc. API commands: TP_CancelOrder
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<success>True</success>
<Command>TP_CANCELORDER</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 494
©2003-2009 Register.com, Inc. API commands: TP_CreateOrder
3/13/09 495
©2003-2009 Register.com, Inc. API commands: TP_CreateOrder
3/13/09 496
©2003-2009 Register.com, Inc. API commands: TP_CreateOrder
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater 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:
<?xml version="1.0" ?>
<interface-response>
<transferorder>
<transferorderid>445413</transferorderid>
<orderdate>7/29/2002 5:19:29 PM</orderdate>
<ordertypeid>1</ordertypeid>
<ordertypedesc>Auto Verification</ordertypedesc>
<statusid>4</statusid>
<statusdesc>Processing</statusdesc>
<authamount>20.00</authamount>
<version>1</version>
<transferorderdetail>
<transferorderdetailid>301770</transferorderdetailid>
<sld>partnerdomain2</sld>
<tld>net</tld>
<statusid>9</statusid>
<statusdesc>Awaiting auto verification of transfer request</statusdesc>
<price>10.00</price>
<usecontacts>0</usecontacts>
</transferorderdetail>
<transferorderdetail>
<transferorderdetailid>301771</transferorderdetailid>
<sld>partnerdomain3</sld>
<tld>info</tld>
<statusid>9</statusid>
<statusdesc>Awaiting auto verification of transfer request</statusdesc>
<price>10.00</price>
<usecontacts>0</usecontacts>
</transferorderdetail>
<transferorderdetailcount>2</transferorderdetailcount>
</transferorder>
<success>True</success>
<Command>TP_CREATEORDER</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 500
©2003-2009 Register.com, Inc. API commands: TP_GetDetailsByDomain
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<TransferOrder>
<orderid>445413</orderid>
<orderdate>3/29/2003 5:19:29 PM</orderdate>
<statusid>9</statusid>
<statusdesc>Awaiting auto verification of transfer request</statusdesc>
</TransferOrder>
<ordercount>1</ordercount>
<Command>TP_GETDETAILSBYDOMAIN</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
PushDomain
TP_CancelOrder
TP_CreateOrder
TP_GetOrder
TP_GetOrderDetail
TP_GetOrderReview
TP_GetOrdersByDomain
TP_GetOrderStatuses
TP_ResendEmail
TP_ResubmitLocked
TP_SubmitOrder
TP_UpdateOrderDetail
UpdatePushList
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
3/13/09 503
©2003-2009 Register.com, Inc. API commands: TP_GetOrder
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<transferorder>
<transferorderid>445413</transferorderid>
<orderdate>7/29/2002 5:19:29 PM</orderdate>
<ordertypeid>1</ordertypeid>
<ordertypedesc>Auto Verification</ordertypedesc>
<statusid>4</statusid>
<statusdesc>Processing</statusdesc>
<authamount>20.00</authamount>
<version>1</version>
<transferorderdetail>
<transferorderdetailid>301770</transferorderdetailid>
<sld>partnerdomain2</sld>
<tld>net</tld>
<statusid>9</statusid>
<statusdesc>Awaiting auto verification of transfer request</statusdesc>
<price>10.00</price>
<usecontacts>0</usecontacts>
</transferorderdetail>
<transferorderdetail>
<transferorderdetailid>301771</transferorderdetailid>
<sld>partnerdomain3</sld>
<tld>info</tld>
<statusid>9</statusid>
<statusdesc>Awaiting auto verification of transfer request</statusdesc>
<price>10.00</price>
<usecontacts>0</usecontacts>
</transferorderdetail>
<transferorderdetailcount>2</transferorderdetailcount>
</transferorder>
<Command>TP_GETORDER</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
3/13/09 505
©2003-2009 Register.com, Inc. API commands: TP_GetOrder
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
PushDomain
TP_CancelOrder
TP_CreateOrder
TP_GetDetailsByDomain
TP_GetOrderDetail
TP_GetOrderReview
TP_GetOrdersByDomain
TP_GetOrderStatuses
TP_ResubmitLocked
TP_SubmitOrder
TP_UpdateOrderDetail
UpdatePushList
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
3/13/09 507
©2003-2009 Register.com, Inc. API commands: TP_GetOrderDetail
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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
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:
<?xml version="1.0" ?>
<interface-response>
<transferorderdetail>
<transferorderdetailid>301770</transferorderdetailid>
<sld>partnerdomain2</sld>
<tld>net</tld>
<lock>True</lock>
<renew>False</renew>
<domainpassword />
<statusid>9</statusid>
<statusdesc>Awaiting auto verification of transfer request</statusdesc>
<price>10.00</price>
<usecontacts>0</usecontacts>
<ordertype />
<contacts>
<Registrant>None</Registrant>
<AuxBilling>None</AuxBilling>
<Tech>None</Tech>
<Admin>None</Admin>
<Billing>
<BillingPartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</BillingPartyID>
<BillingAddress1>111 Main Street</BillingAddress1>
<BillingAddress2 />
<BillingCity>Hometown</BillingCity>
<BillingCountry>US</BillingCountry>
<BillingEmailAddress>[email protected]</BillingEmailAddress>
<BillingFax>+1.5555555556</BillingFax>
<BillingFirstName>John</BillingFirstName>
<BillingJobTitle>President</BillingJobTitle>
<BillingLastName>Doe</BillingLastName>
<BillingOrganizationName>Partner Domains Inc.</BillingOrganizationName>
<BillingPhone>+1.5555555555</BillingPhone>
<BillingPostalCode>99999</BillingPostalCode>
<BillingStateProvince>NY</BillingStateProvince>
<BillingStateProvinceChoice>S</BillingStateProvinceChoice>
<BillingFullCountry>United States</BillingFullCountry>
<UseRegInfoAbove>True</UseRegInfoAbove>
<auxID />
<regID />
</Billing>
</contacts>
</transferorderdetail>
<Command>TP_GETORDERDETAIL</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
3/13/09 509
©2003-2009 Register.com, Inc. API commands: TP_GetOrderDetail
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
PushDomain
TP_CancelOrder
TP_CreateOrder
TP_GetDetailsByDomain
TP_GetOrder
TP_GetOrderReview
TP_GetOrdersByDomain
TP_GetOrderStatuses
TP_ResendEmail
TP_ResubmitLocked
TP_SubmitOrder
TP_UpdateOrderDetail
UpdatePushList
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
3/13/09 511
©2003-2009 Register.com, Inc. API commands: TP_GetOrderReview
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<transferorderid>465681</transferorderid>
<ordertype>Transfer</ordertype>
<transferorderreview>
<transferorderdetail>
<transferorderdetailid>311389</transferorderdetailid>
<sld>transferdomain</sld>
<tld>com</tld>
<price>8.95</price>
<lock>True</lock>
3/13/09 512
©2003-2009 Register.com, Inc. API commands: TP_GetOrderReview
<renew>True</renew>
<domainpassword />
<usecontacts>1</usecontacts>
<authinfo />
<RRProcessor>Partner Domains Inc.</RRProcessor>
</transferorderdetail>
<transferorderdetailcount>1</transferorderdetailcount>
<transfertotalprice>8.95</transfertotalprice>
<authinfostillrequired>No</authinfostillrequired>
</transferorderreview>
<Command>TP_GETORDERREVIEW</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>e</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.1132813</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
PushDomain
TP_CancelOrder
TP_CreateOrder
TP_GetDetailsByDomain
TP_GetOrder
TP_GetOrderDetail
TP_GetOrdersByDomain
TP_GetOrderStatuses
TP_ResubmitLocked
TP_SubmitOrder
TP_UpdateOrderDetail
UpdatePushList
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
3/13/09 514
©2003-2009 Register.com, Inc. API commands: TP_GetOrdersByDomain
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<TransferOrder>
<transferorderid>445413</transferorderid>
<loginid>rcompartnerid</loginid>
<orderdate>7/29/2002 5:19:29 PM</orderdate>
<orderstatus>Processing</orderstatus>
<statusid>4</statusid>
</TransferOrder>
<ordercount>1</ordercount>
<Command>TP_GETORDERSBYDOMAIN</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 517
©2003-2009 Register.com, Inc. API commands: TP_GetOrderStatuses
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<transferorder>
<transferorderid>445413</transferorderid>
<orderdate>2002-07-29T17:19:29.437</orderdate>
<statusid>4</statusid>
<tos>
<statusdesc>Processing</statusdesc>
<ordertypeid>1</ordertypeid>
<tot>
<ordertypedesc>Auto Verification</ordertypedesc>
</tot>
</tos>
</transferorder>
<transferorder>
.
.
.
</transferorder>
<FoundAtLeastOnePendingOrder>False</FoundAtLeastOnePendingOrder>
<Command>TP_GETORDERSTATUSES</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
3/13/09 518
©2003-2009 Register.com, Inc. API commands: TP_GetOrderStatuses
</debug>
</interface-response>
Related commands
PushDomain
TP_CancelOrder
TP_CreateOrder
TP_GetDetailsByDomain
TP_GetOrder
TP_GetOrderDetail
TP_GetOrderReview
TP_GetOrdersByDomain
TP_ResubmitLocked
TP_SubmitOrder
TP_UpdateOrderDetail
UpdatePushList
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
3/13/09 520
©2003-2009 Register.com, Inc. API commands: TP_GetTLDInfo
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<tldtable>
<tld>
<TLDID>0</TLDID>
<TLD>com</TLD>
<Protocol>RRP</Protocol>
<AbleToLock>True</AbleToLock>
<RealTime>True</RealTime>
<Transferable>True</Transferable>
3/13/09 521
©2003-2009 Register.com, Inc. API commands: TP_GetTLDInfo
<HasAuthInfo>False</HasAuthInfo>
<TransByAutoVeri>True</TransByAutoVeri>
<TransByFax>True</TransByFax>
</tld>
<tld>
<TLDID>1</TLDID>
<TLD>net</TLD>
<Protocol>RRP</Protocol>
<AbleToLock>True</AbleToLock>
<RealTime>True</RealTime>
<Transferable>True</Transferable>
<HasAuthInfo>False</HasAuthInfo>
<TransByAutoVeri>True</TransByAutoVeri>
<TransByFax>True</TransByFax>
</tld>
<tld>
<TLDID>2</TLDID>
<TLD>org</TLD>
<Protocol>EPP</Protocol>
<AbleToLock>True</AbleToLock>
<RealTime>True</RealTime>
<Transferable>True</Transferable>
<HasAuthInfo>True</HasAuthInfo>
<TransByAutoVeri>True</TransByAutoVeri>
<TransByFax>True</TransByFax>
</tld>
<tld>
<TLDID>3</TLDID>
<TLD>cc</TLD>
<Protocol>RRP</Protocol>
<AbleToLock>True</AbleToLock>
<RealTime>True</RealTime>
<Transferable>True</Transferable>
<HasAuthInfo>False</HasAuthInfo>
<TransByAutoVeri>True</TransByAutoVeri>
<TransByFax>True</TransByFax>
</tld>
</tldtable>
<tldcount>4</tldcount>
<Command>TP_GETTLDINFO</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.1171875</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 524
©2003-2009 Register.com, Inc. API commands: TP_ResendEmail
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:
<?xml version="1.0" ?>
<interface-response>
<Success>True</Success>
<Command>TP_RESENDEMAIL</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>Reseller5</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+03.00</TimeDifference>
<ExecTime>0.15625</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 527
©2003-2009 Register.com, Inc. API commands: TP_ResubmitLocked
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater 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:
<?xml version="1.0" ?>
<interface-response>
<transferorder>
<transferorderid>952245</transferorderid>
</transferorder>
<success>True</success>
<Command>TP_RESUBMITLOCKED</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![ CDATA[ ] ]>
</debug>
</interface-response>
Related commands
PushDomain
TP_CancelOrder
TP_CreateOrder
TP_GetDetailsByDomain
TP_GetOrder
TP_GetOrderDetail
TP_GetOrderReview
TP_GetOrdersByDomain
TP_GetOrderStatuses
TP_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
3/13/09 529
©2003-2009 Register.com, Inc. API commands: TP_SubmitOrder
3/13/09 530
©2003-2009 Register.com, Inc. API commands: TP_SubmitOrder
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater 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:
<?xml version="1.0" ?>
<interface-response>
<success>True</success>
<Command>TP_SUBMITORDER</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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 transfer order detail ID must be valid and must be part of an 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
3/13/09 533
©2003-2009 Register.com, Inc. API commands: TP_UpdateOrderDetail
3/13/09 534
©2003-2009 Register.com, Inc. API commands: TP_UpdateOrderDetail
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:
<?xml version="1.0" ?>
<interface-response>
<transferorderdetail>
<transferorderdetailid>301770</transferorderdetailid>
<sld>partnerdomain2</sld>
<tld>net</tld>
<lock>True</lock>
<renew>True</renew>
<domainpassword />
<statusid>10</statusid>
<statusdesc>Unable to retrieve current domain contacts from UW</statusdesc>
<price>10.00</price>
<usecontacts>0</usecontacts>
<ordertype />
<contacts>
<Registrant>
<RegistrantPartyID>
{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}
</RegistrantPartyID>
<RegistrantAddress1>111 Main Street</RegistrantAddress1>
<RegistrantAddress2 />
<RegistrantCity>Hometown</RegistrantCity>
<RegistrantCountry>US</RegistrantCountry>
<RegistrantEmailAddress>[email protected]</RegistrantEmailAddress>
<RegistrantFax>555-555-5556</RegistrantFax>
<RegistrantFirstName>John</RegistrantFirstName>
<RegistrantJobTitle>President</RegistrantJobTitle>
<RegistrantLastName>Doe</RegistrantLastName>
<RegistrantOrganizationName>Partner Domains Inc.</RegistrantOrganizationName>
<RegistrantPhone>555-555-5555</RegistrantPhone>
<RegistrantPostalCode>99999</RegistrantPostalCode>
<RegistrantStateProvince>NY</RegistrantStateProvince>
<RegistrantStateProvinceChoice>S</RegistrantStateProvinceChoice>
</Registrant>
<AuxBilling>None</AuxBilling>
<Tech>None</Tech>
<Admin>None</Admin>
<Billing>
<BillingPartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</BillingPartyID>
<BillingAddress1>111 Main Street</BillingAddress1>
3/13/09 536
©2003-2009 Register.com, Inc. API commands: TP_UpdateOrderDetail
<BillingAddress2 />
<BillingCity>Hometown</BillingCity>
<BillingCountry>US</BillingCountry>
<BillingEmailAddress>[email protected]</BillingEmailAddress>
<BillingFax>555-555-5556</BillingFax>
<BillingFirstName>John</BillingFirstName>
<BillingJobTitle>President</BillingJobTitle>
<BillingLastName>Doe</BillingLastName>
<BillingOrganizationName>Partner Domains Inc.</BillingOrganizationName>
<BillingPhone>555-555-5555</BillingPhone>
<BillingPostalCode>99999</BillingPostalCode>
<BillingStateProvince>NY</BillingStateProvince>
<BillingStateProvinceChoice>S</BillingStateProvinceChoice>
<BillingFullCountry>United States</BillingFullCountry>
<UseBelowAuxInfo>True</UseBelowAuxInfo>
<auxID />
<regID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</regID>
</Billing>
</contacts>
</transferorderdetail>
<success>True</success>
<Command>TP_UPDATEORDERDETAIL</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
PushDomain
TP_CancelOrder
TP_CreateOrder
TP_GetDetailsByDomain
TP_GetOrder
TP_GetOrderDetail
TP_GetOrderReview
TP_GetOrdersByDomain
TP_GetOrderStatuses
TP_GetTLDInfo
TP_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
3/13/09 538
©2003-2009 Register.com, Inc. API commands: UpdateAccountInfo
3/13/09 539
©2003-2009 Register.com, Inc. API commands: UpdateAccountInfo
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:
<?xml version="1.0" ?>
<interface-response>
<StatusEditContact>Successful</StatusEditContact>
<OrganizationName>Partner Domains Inc.</OrganizationName>
<JobTitle>President</JobTitle>
<Fname>John</Fname>
<Lname>Doe</Lname>
<Address1>111 Main St.</Address1>
<Address2 />
<City>Hometown</City>
<StateProvince>NY</StateProvince>
<StateProvinceChoice>S</StateProvinceChoice>
<PostalCode>99999</PostalCode>
<Country>US</Country>
<Phone>5555555555</Phone>
<Fax>5555555556</Fax>
<EmailAddress>[email protected]</EmailAddress>
<EmailAddress_Contact>[email protected]</EmailAddress_Contact>
<URL />
<GetAccountInfo>
<UserID>rcompartnerid</UserID>
<Password>rcompartnerpw</Password>
<AuthQuestionType>smaiden</AuthQuestionType>
<AuthQuestionAnswer>Jones</AuthQuestionAnswer>
<Account>217-no-0647</Account>
<Reseller>True</Reseller>
<AcceptTerms>True</AcceptTerms>
</GetAccountInfo>
<GetCustomerPaymentInfo>
<CCName />
<CCNumber />
<CCType />
<CCMonth />
<CCYear />
</GetCustomerPaymentInfo>
3/13/09 541
©2003-2009 Register.com, Inc. API commands: UpdateAccountInfo
<GetCustomerPreferences>
<DefPeriod />
</GetCustomerPreferences>
<Command>UPDATEACCOUNTINFO</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
CheckLogin
CreateAccount
CreateSubAccount
GetAccountInfo
GetAccountPassword
GetAllAccountInfo
GetCustomerPaymentInfo
GetOrderDetail
GetOrderList
GetReport
GetSubAccountDetails
GetSubAccounts
GetTransHistory
UpdateCusPreferences
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
3/13/09 543
©2003-2009 Register.com, Inc. API commands: UpdateAccountPricing
3/13/09 544
©2003-2009 Register.com, Inc. API commands: UpdateAccountPricing
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<Set>
<Account>154-dz-5567</Account>
<AcctType>reseller</AcctType>
<Count>5</Count>
<Status>Successful</Status>
</Set>
<Command>UPDATEACCOUNTPRICING</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 547
©2003-2009 Register.com, Inc. API commands: UpdateCart
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<Command>UPDATECART</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 549
©2003-2009 Register.com, Inc. API commands: UpdateCusPreferences
3/13/09 550
©2003-2009 Register.com, Inc. API commands: UpdateCusPreferences
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter
Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
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:
<?xml version="1.0" ?>
<interface-response>
<Command>UPDATECUSPREFERENCES</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<IsLockable>0</IsLockable>
<IsRealTimeTLD>0</IsRealTimeTLD
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
CheckLogin
CreateAccount
CreateSubAccount
GetAccountInfo
GetAccountPassword
GetAllAccountInfo
GetConfirmationSettings
GetCusPreferences
GetCustomerPaymentInfo
GetOrderDetail
GetOrderList
GetReport
GetSubAccountDetails
GetSubAccounts
GetTransHistory
SetPakRenew
UpdateAccountInfo
UpdateRenewalSettings
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
3/13/09 553
©2003-2009 Register.com, Inc. API commands: UpdateExpiredDomains
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<ReactivateDomainName>
<Status>REACTIVATION PROCESSED SUCCESSFULLY! The orderid is 156514444.</Status>
</ReactivateDomainName>
<Command>UPDATEEXPIREDDOMAINS</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 555
©2003-2009 Register.com, Inc. API commands: UpdateMetaTag
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<DomainRRP>E</DomainRRP>
<RegistrarHold>False</RegistrarHold>
<metatags>
<titlebar>MY COOL TITLE</titlebar>
<sitedescription>MY SITE DESCRIPTION</sitedescription>
<keywords>MY SITE KEYWORDS</keywords>
<DomainNameID>152533676</DomainNameID>
</metatags>
<Command>UPDATEMETATAG</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>False</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 558
©2003-2009 Register.com, Inc. API commands: UpdateNameServer
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<RegisterNameserver>
<NsSuccess>1</NsSuccess>
</RegisterNameserver>
<RRPCode>200</RRPCode>
<RRPText>Command completed successfully</RRPText>
<Command>UPDATENAMESERVER</Command>
<ErrCount>0</ErrCount>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
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:
<interface-response>
<Update>Successful</Update>
<Command>UPDATENOTIFICATIONAMOUNT</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod/>
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable/>
<IsRealTimeTLD/>
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.0703125</ExecTime>
<Done>true</Done>
<debug>
[CDATA]
</debug>
</interface-response>
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
3/13/09 562
©2003-2009 Register.com, Inc. API commands: UpdatePushList
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<UPDATEPUSHLIST>
<PUSH-DOMAIN>
<DomainName>partnerdomain2.net</DomainName>
<DomainListWrongFormat>Valid</DomainListWrongFormat>
<DomainNameNotInYourAccount>Yes</DomainNameNotInYourAccount>
<SuccessfulPush>Yes</SuccessfulPush>
</PUSH-DOMAIN>
<PUSH-DOMAIN>
<DomainName>partnerdomain3.info</DomainName>
<DomainListWrongFormat>Valid</DomainListWrongFormat>
<DomainNameNotInYourAccount>Yes</DomainNameNotInYourAccount>
<SuccessfulPush>Yes</SuccessfulPush>
</PUSH-DOMAIN>
</UPDATEPUSHLIST>
<Command>UPDATEPUSHLIST</Command>
<ErrCount>0</ErrCount>
<Server>ResellerTest</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
3/13/09 565
©2003-2009 Register.com, Inc. API commands: UpdateRenewalSettings
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<UpdateRenewalSettings>
<AcceptTermsStatus>Successful</AcceptTermsStatus>
<RenewalSetting>Successful</RenewalSetting>
</UpdateRenewalSettings>
<Command>UPDATERENEWALSETTINGS</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
3/13/09 566
©2003-2009 Register.com, Inc. API commands: UpdateRenewalSettings
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>LOCALHOST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.046875</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
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
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:
<?xml version="1.0" ?>
<interface-response>
<RegistrarHold>False</RegistrarHold>
<Command>VALIDATEPASSWORD</Command>
<ErrCount>0</ErrCount>
<Server>Dev Workstation</Server>
<Site>rcom</Site>
<Done>true</Done>
<debug>
<![CDATA[ ] ]>
</debug>
</interface-response>
Related commands
GetAllDomains
GetDomainCount
GetDomainExp
GetDomainInfo
GetDomains
GetExtendInfo
GetPasswordBit
GetRegistrationStatus
GetRegLock
GetRenew
GetSubAccountPassword
SetPassword
SetRegLock
SetRenew
StatusDomain
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
3/13/09 570
©2003-2009 Register.com, Inc. API commands: WSC_GetAccountInfo
3/13/09 571
©2003-2009 Register.com, Inc. API commands: WSC_GetAccountInfo
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<WSCHostAccounts>
<HostPackage>
<WebHostID>1398</WebHostID>
<HostAccount>LWSC123x4567</HostAccount>
<WebStorage />
<BandWidth />
<SQLSize />
<DatabaseType />
<POPMailBoxes />
<Overage />
<BillingDate>1/14/2007</BillingDate>
<Status>Active</Status>
<OSType />
<Terminate>False</Terminate>
<TerminateDate />
<HasWSC>True</HasWSC>
<WSCEnabled>True</WSCEnabled>
<WSCLaunchURL>http://wsc.ehost-services.com/servlet/
CMWizardLN?flush=F7480EBA6798052499D1BA835B436021</WSCLaunchURL>
<currentplanprice>15.05</currentplanprice>
<canupgrade>False</canupgrade>
<wscfullprice />
<wscecommerceprice />
<wscversion>Ecommerce</wscversion>
<HostHeaderDomains>
<Domains>
<Domain>partnerdomain.com</Domain>
<DomainNameID>152566773</DomainNameID>
<WSCOnlyHeaders>True</WSCOnlyHeaders>
3/13/09 572
©2003-2009 Register.com, Inc. API commands: WSC_GetAccountInfo
<HasPOP>True</HasPOP>
</Domains>
<Domains>
<Domain>partnerdomain2.net</Domain>
<DomainNameID>318282340</DomainNameID>
<WSCOnlyHeaders>True</WSCOnlyHeaders>
<HasPOP>False</HasPOP>
</Domains>
<Domains>
<Domain>partnerdomain3.info</Domain>
<DomainNameID>318282341</DomainNameID>
<WSCOnlyHeaders>True</WSCOnlyHeaders>
<HasPOP>True</HasPOP>
</Domains>
</HostHeaderDomains>
<hashostheaders>True</hashostheaders>
<wscpath>WSC</wscpath>
<siteurl>http://www.partnerdomain.com</siteurl>
<IsLWSC>False</IsLWSC>
<wscsiteid>100</wscsiteid>
<PointedTo>True</PointedTo>
<lwscperiodicbilling>
<currentbillperiod />
<nextbillperiod />
<DiscountPlans>
<Plan>
<Month>3</Month>
<PromoID>53</PromoID>
<DiscountPercent>10</DiscountPercent>
</Plan>
<Plan>
<Month>6</Month>
<PromoID>54</PromoID>
<DiscountPercent>15</DiscountPercent>
</Plan>
<Plan>
<Month>12</Month>
<PromoID>55</PromoID>
<DiscountPercent>20</DiscountPercent>
</Plan>
</DiscountPlans>
<DiscountPlanCnt>3</DiscountPlanCnt>
<CanUpdate>True</CanUpdate>
<deletedate />
</lwscperiodicbilling>
</HostPackage>
<AvailableHeaderDomains />
<availabledomainlist>False</availabledomainlist>
<availabledomaincount>836</availabledomaincount>
</WSCHostAccounts>
<Command>WSC_GETACCOUNTINFO</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
3/13/09 573
©2003-2009 Register.com, Inc. API commands: WSC_GetAccountInfo
<ExecTime>7.546875</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
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
3/13/09 575
©2003-2009 Register.com, Inc. API commands: WSC_GetAllPackages
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
3/13/09 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:
<?xml version="1.0" ?>
<interface-response>
<WSCHostAccounts>
<HostPackage>
<WebHostID>1398</WebHostID>
<HostAccount>test121406</HostAccount>
<WebStorage />
<BandWidth />
<SQLSize />
<DatabaseType />
<POPMailBoxes />
<Overage />
<BillingDate>1/14/2007</BillingDate>
<Status>Active</Status>
<OSType />
<Terminate>False</Terminate>
<TerminateDate />
<HasWSC>True</HasWSC>
<WSCEnabled>True</WSCEnabled>
<WSCLaunchURL>http://wsc.ehost-services.com/servlet/
CMWizardLN?flush=7D2643832113A75809908A9F1913DC72</WSCLaunchURL>
<currentplanprice>15.05</currentplanprice>
<canupgrade>False</canupgrade>
<wscfullprice />
<wscecommerceprice />
<wscversion>Ecommerce</wscversion>
<HostHeaderDomains>
<Domains>
<Domain>partnerdomain.com</Domain>
<DomainNameID>152566773</DomainNameID>
<WSCOnlyHeaders>True</WSCOnlyHeaders>
<HasPOP>True</HasPOP>
</Domains>
<Domains>
<Domain>partnerdomain2.net</Domain>
<DomainNameID>318282340</DomainNameID>
<WSCOnlyHeaders>True</WSCOnlyHeaders>
<HasPOP>False</HasPOP>
</Domains>
<Domains>
<Domain>partnerdomain3.info</Domain>
<DomainNameID>318282341</DomainNameID>
<WSCOnlyHeaders>True</WSCOnlyHeaders>
<HasPOP>True</HasPOP>
</Domains>
</HostHeaderDomains>
<hashostheaders>True</hashostheaders>
<wscpath>WSC</wscpath>
<siteurl>http://www.partnerdomain.com</siteurl>
<IsLWSC>False</IsLWSC>
3/13/09 577
©2003-2009 Register.com, Inc. API commands: WSC_GetAllPackages
<wscsiteid>100</wscsiteid>
<PointedTo>True</PointedTo>
<lwscperiodicbilling>
<currentbillperiod />
<nextbillperiod />
<DiscountPlans>
<Plan>
<Month>3</Month>
<PromoID>53</PromoID>
<DiscountPercent>10</DiscountPercent>
</Plan>
<Plan>
<Month>6</Month>
<PromoID>54</PromoID>
<DiscountPercent>15</DiscountPercent>
</Plan>
<Plan>
<Month>12</Month>
<PromoID>55</PromoID>
<DiscountPercent>20</DiscountPercent>
</Plan>
</DiscountPlans>
<DiscountPlanCnt>3</DiscountPlanCnt>
<CanUpdate>True</CanUpdate>
<deletedate />
</lwscperiodicbilling>
</HostPackage>
.
.
.
</interface-response>
Related commands
AddToCart
GetAllDomains
PurchaseServices
WSC_GetAccountInfo
WSC_GetPricing
WSC_Update_Ops
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
3/13/09 579
©2003-2009 Register.com, Inc. API commands: WSC_GetPricing
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If greater than 0 the 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:
<?xml version="1.0" ?>
<interface-response>
<wscpricing>
<wscbasicprice>2.85</wscbasicprice>
<wscfullprice>5.75</wscfullprice>
<wscecommerceprice>9.25</wscecommerceprice>
<lwscbasicprice>2.85</lwscbasicprice>
<lwscfullprice>5.75</lwscfullprice>
<lwscecommerceprice>11.75</lwscecommerceprice>
</wscpricing>
<wscdemo>
<wscdemourl>http://wsc.ehost-services.com/create_demo_account.jsp?productId=
WSCENOSSSLYTC215&clientId=RRENOS999JZT4SYQ&language=en&country=US&
wl_name=wl_rcom&demoCallbackUrl=</wscdemourl>
</wscdemo>
<Command>WSC_GETPRICING</Command>
<Language>en</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
3/13/09 580
©2003-2009 Register.com, Inc. API commands: WSC_GetPricing
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.1484375</ExecTime>
<Done>true</Done>
<debug>
<![CDATA[ ]]>
</debug>
</interface-response>
Related commands
AddToCart
GetAllDomains
PurchaseServices
WSC_GetAccountInfo
WSC_GetAllPackages
WSC_Update_Ops
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 Use this command:
way:
No WSC WSC Lite No purchase necessary for ServiceSelect
WSC Lite
No WSC Lite Basic Real time PurchaseServices
Lite Full
Lite eCommerce
No WSC Lite Basic Shopping cart ServiceSelect to create Lite,
Lite Full then AddToCart to upgrade to
Lite eCommerce higher plan
Lite Basic Upgrade to a Billing amount is deducted WSC_Update_Ops in the last
Lite Full higher plan from your account balance month of the current billing
cycle
Lite Basic Change to a Billing amount is deducted WSC_Update_Ops in the last
Lite Full different billing from your account balance month of the current billing
Lite eCommerce cycle 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:
• 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.
3/13/09 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
Notes
• The default response format is plain text. To receive the response in HTML or XML format, send
ResponseType=HTML or ResponseType=XML in your request.
• Check the return parameter ErrCount. If 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:
<?xml version="1.0" ?>
<interface-response>
<AccountStatusID>1</AccountStatusID>
<Successful>True</Successful>
<Successful>True</Successful>
<PlanUpdated>True</PlanUpdated>
<BillingCycleUpdated>True</BillingCycleUpdated>
<Command>WSC_UPDATE_OPS</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod />
<MaxPeriod>10</MaxPeriod>
<Server>RESELLERTEST</Server>
<Site>rcom</Site>
<IsLockable />
<IsRealTimeTLD />
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.078125</ExecTime>
<Done>true</Done>
</interface-response>
Related commands
AddToCart
Purchase
PurchaseServices
ServiceSelect
WSC_GetAccountInfo
WSC_GetAllPackages
WSC_GetPricing
3/13/09 584
©2003-2009 Register.com, Inc. Index
Index
A RefillAccount . . . . . . . . . . . . . . . . . . . 411
account ID RemoveTLD . . . . . . . . . . . . . . . . . . . . 418
validating . . . . . . . . . . . . . . . . . . . . . 69 RPT_GetReport . . . . . . . . . . . . . . . . . 429
accounting SendAccountEmail . . . . . . . . . . . . . . . 434
CommissionAccount . . . . . ......... 75 UpdateAccountInfo . . . . . . . . . . . . . . . 538
GetBalance . . . . . . . . . . . ......... 147 UpdateCusPreferences . . . . . . . . . . . . 549
PE_GetCustomerPricing . . ......... 347 UpdateNotificationAmount . . . . . . . . . . . 560
PE_GetDomainPricing . . . ......... 350 UpdateRenewalSettings . . . . . . . . . . . . 565
PE_GetPOPPrice . . . . . . . ......... 353 validating user ID . . . . . . . . . . . . . . . . 69
PE_GetProductPrice . . . . . ......... 355 AddBulkDomains . . . . . . . . . . . . . . . . . . . 15
PE_GetResellerPrice . . . . ......... 358 AddContact . . . . . . . . . . . . . . . . . . . . . . . 18
PE_GetRetailPrice . . . . . . ......... 361 AddToCart . . . . . . . . . . . . . . . . . . . . . . . . 21
PE_GetRetailPricinge . . . . ......... 364 AdvancedDomainSearch . . . . . . . . . . . . . . 31
PE_SetPricing . . . . . . . . . ......... 370 auctions
SetResellerServicesPricing ......... 471 Check . . . . . . . . . . . . . . . . . . . . . . . . 66
SetResellerTLDPricing . . . ......... 474 authorization key
UpdateAccountPricing . . . . ......... 543 GetContacts . . . . . . . . . . . . . . . . . . . . 160
accounts AuthorizeTLD . . . . . . . . . . . . . . . . . . . . . . 37
AuthorizeTLD . . . . . . . . . ......... 37 automatic renewals
CheckLogin . . . . . . . . . . . ......... 69 GetCusPreferences . . . . . . . . . . . . . . . 164
CreateAccount . . . . . . . . . ......... 81 GetRenew . . . . . . . . . . . . . . . . . . . . . 267
CreateSubAccount . . . . . . ......... 86 SetPakRenew . . . . . . . . . . . . . . . . . . 458
DeleteSubaccount . . . . . . ......... 109 SetRenew . . . . . . . . . . . . . . . . . . . . . 468
GetAccountInfo . . . . . . . . ......... 130 UpdateCusPreferences . . . . . . . . . . . . 549
GetAccountPassword . . . . ......... 133 UpdateRenewalSettings . . . . . . . . . . . . 565
GetAccountValidation . . . . ......... 135 availability
GetAllAccountInfo . . . . . . ......... 141 checking domain names . . . . . . . . . . . . 66
GetConfirmationSettings . . ......... 157
GetCusPreferences . . . . . ......... 164 B
GetCustomerPaymentInfo . ......... 170 balances
GetDomainCount . . . . . . . ......... 177 GetBalance . . . . . . . . . . . . . . . . . . . . 147
GetDomains . . . . . . . . . . ......... 189 RefillAccount . . . . . . . . . . . . . . . . . . . 411
GetOrderDetail . . . . . . . . ......... 241 UpdateNotificationAmount . . . . . . . . . . . 560
GetOrderList . . . . . . . . . . ......... 244 bulk
GetReport . . . . . . . . . . . . ......... 270 PE_GetPOPPrice . . . . . . . . . . . . . . . . 353
GetResellerInfo . . . . . . . . ......... 273 PurchasePOPBundle . . . . . . . . . . . . . . 393
GetSubAccountDetails . . . ......... 282 purchasing domains . . . . . . . . . . . . . . . 15
GetSubAccounts . . . . . . . ......... 290 pushing domains to another account . . . . 562
GetSubAccountsDetailList . ......... 293 BundleID
GetTLDList . . . . . . . . . . . ......... 296 retrieving . . . . . . . . . . . . . . . . . . . . . . 249
GetTransHistory . . . . . . . . ......... 299
3/13/09 585
©2003-2009 Register.com, Inc. Index:
C GetCartContent . . . . . . . . . . . . . . . . . 149
cancelling orders country code
DeleteRegistration . . . . . . . . . . . . . . . 106 GetExtAttributes . . . . . . . . . . . . . . . . . 211
transfer orders . . . . . . . . . . . . . . . . . . 491 country codes
cart Preconfigure . . . . . . . . . . . . . . . . . . . 374
AddBulkDomains . . . . . . .......... 15 CreateAccount . . . . . . . . . . . . . . . . . . . . . 81
AddToCart . . . . . . . . . . .......... 21 CreateSubAccount . . . . . . . . . . . . . . . . . . 86
DeleteFromCart . . . . . . . .......... 95 customer notifications
GetCartContent . . . . . . . .......... 149 UpdateRenewalSettings . . . . . . . . . . . . 565
InsertNewOrder . . . . . . . .......... 330 customer support
Purchase . . . . . . . . . . . .......... 380 GetServiceContact . . . . . . . . . . . . . . . 279
PurchasePreview . . . . . . .......... 396 customer-defined data . . . . . . . . . . . . . . . . 442
UpdateCart . . . . . . . . . . .......... 547 DeleteCustomerDefinedData . . . . . . . . . 93
CertConfigureCert . . . . . . . . .......... 40 GetCustomerDefinedData . . . . . . . . . . . 167
CertGetApproverEmail . . . . . .......... 47 customers
CertGetCertDetail . . . . . . . . . .......... 50 CreateAccount . . . . . . . . . . . . . . . . . . 81
CertGetCerts . . . . . . . . . . . . .......... 54 CreateSubAccount . . . . . . . . . . . . . . . 86
CertModifyCert . . . . . . . . . . .......... 57 GetAccountInfo . . . . . . . . . . . . . . . . . . 130
CertParseCSR . . . . . . . . . . . .......... 60 GetAllAccountInfo . . . . . . . . . . . . . . . . 141
CertPurchaseCert. . . . . . . . . .......... 63 GetCustomerPaymentInfo . . . . . . . . . . . 170
certs GetResellerInfo . . . . . . . . . . . . . . . . . . 273
CertConfigureCert . . . . . .......... 40
CertGetApproverEmail . . .......... 47 D
CertGetCertDetail . . . . . . .......... 50 DeleteAllPOPPaks . . . . . . . . . . . . . . . . . . 89
CertGetCerts item list . . . .......... 54 DeleteContact . . . . . . . . . . . . . . . . . . . . . 91
CertModifyCert . . . . . . . .......... 57 DeleteCustomerDefinedData . . . . . . . . . . . . 93
CertParseCSR . . . . . . . . .......... 60 DeleteFromCart . . . . . . . . . . . . . . . . . . . . 95
CertPurchaseCert . . . . . .......... 63 DeleteHostedDomain . . . . . . . . . . . . . . . . . 97
GetCerts product list . . . . .......... 154 DeleteNameserver . . . . . . . . . . . . . . . . . . 99
PurchaseServices . . . . . .......... 399 DeletePOP3 . . . . . . . . . . . . . . . . . . . . . . . 102
Check . . . . . . . . . . . . . . . . .......... 66 DeletePOPPak . . . . . . . . . . . . . . . . . . . . . 104
checking out DeleteRegistration . . . . . . . . . . . . . . . . . . . 106
DeleteFromCart . . . . . . . . . . . . . . . . . 95 DeleteSubaccount . . . . . . . . . . . . . . . . . . . 109
CheckLogin . . . . . . . . . . . . . . . . . . . . . . . 69 DisableServices . . . . . . . . . . . . . . . . . . . . 111
CheckNSStatus . . . . . . . . . . . . . . . . . . . . 72 DNS
checkout CheckNSStatus . . . . . . . . . . . . . . . . . 72
Purchase . . . . . . . . . . . .......... 380 GetDNS . . . . . . . . . . . . . . . . . . . . . . 173
PurchasePreview . . . . . . .......... 396 GetDNSStatus . . . . . . . . . . . . . . . . . . 175
UpdateCart . . . . . . . . . . .......... 547 ModifyNS . . . . . . . . . . . . . . . . . . . . . 333
CommissionAccount . . . . . . . .......... 75 ModifyNSHosting . . . . . . . . . . . . . . . . 336
configure redirect hosting . . . . . . . . . . . . . . . . . . 336
GetExtAttributes . . . . . . . . . . . . . . . . . 211 DNS hosting
configuring extended attributes DeleteHostedDomain . . . . . . . . . . . . . . 97
Preconfigure . . . . . . . . . . . . . . . . . . . 374 ExtendDomainDNS . . . . . . . . . . . . . . . 123
contact information PurchaseHosting . . . . . . . . . . . . . . . . . 389
AddContact . . . . . . . . . . .......... 18 PurchaseServices . . . . . . . . . . . . . . . . 399
Contacts . . . . . . . . . . . . .......... 77 domain management
DeleteContact . . . . . . . . .......... 91 AdvancedDomainSearch . . . . . . . . . . . 31
GetAddressBook . . . . . . .......... 137 CheckNSStatus . . . . . . . . . . . . . . . . . 72
GetAllAccountInfo . . . . . .......... 141 GetAllDomains . . . . . . . . . . . . . . . . . . 144
GetContacts . . . . . . . . . .......... 160 GetDomainCount . . . . . . . . . . . . . . . . 177
GetForwarding . . . . . . . . .......... 218 GetDomainExp . . . . . . . . . . . . . . . . . . 180
GetServiceContact . . . . . .......... 279 GetDomainInfo . . . . . . . . . . . . . . . . . . 182
GetSubaccountsDetailList .......... 293 GetDomains . . . . . . . . . . . . . . . . . . . . 189
GetWhoisContact . . . . . . .......... 303 GetDomainStatus . . . . . . . . . . . . . . . . 201
ServiceSelect . . . . . . . . .......... 436 GetExpiredDomains . . . . . . . . . . . . . . . 208
Contacts . . . . . . . . . . . . . . . .......... 77 GetExtendInfo . . . . . . . . . . . . . . . . . . 215
contents GetHomeDomainList . . . . . . . . . . . . . . 230
GetPasswordBit . . . . . . . . . . . . . . . . . 247
3/13/09 586
©2003-2009 Register.com, Inc. Index:
3/13/09 587
©2003-2009 Register.com, Inc. Index:
3/13/09 588
©2003-2009 Register.com, Inc. Index:
H SetRegLock . . . . . . . . . . . . . . . . . . . . 465
HE_CancelAccount . . . . . ............ 309 login
HE_ChangePassword . . . . ............ 312 validating . . . . . . . . . . . . . . . . . . . . . . 69
HE_CreateAccount . . . . . . ............ 315
HE_GetAccountDetails . . . ............ 318 M
HE_GetAccounts . . . . . . . ............ 321 mail
HE_GetPricing . . . . . . . . . ............ 324 GetSPFHosts . . . . . . . . . . . . . . . . . . . 276
HE_UpgradeAccount . . . . ............ 327 SetSPFHosts . . . . . . . . . . . . . . . . . . . 477
history mail records
get transaction history . . . . . . . . . . . . . 299 GetMailHosts . . . . . . . . . . . . . . . . . . . 236
RPT_GetReport . . . . . . . . . . . . . . . . . 429 mail services
host records DeleteAllPOPPaks . . . . . . . . . . . . . . . 89
GetDomainSRVHosts . ............ 198 DeletePOP3 . . . . . . . . . . . . . . . . . . . . 102
GetHosts . . . . . . . . . ............ 233 DeletePOPPak . . . . . . . . . . . . . . . . . . 104
GetMetaTag . . . . . . . ............ 239 Forwarding . . . . . . . . . . . . . . . . . . . . 127
GetRegHosts . . . . . . ............ 259 GetCatchAll . . . . . . . . . . . . . . . . . . . . 152
SetDNSHost . . . . . . . ............ 445 GetDotNameForwarding . . . . . . . . . . . . 206
SetDomainSRVHosts . ............ 447 GetForwarding . . . . . . . . . . . . . . . . . . 218
SetHosts . . . . . . . . . ............ 455 GetPOP3 . . . . . . . . . . . . . . . . . . . . . . 249
UpdateMetaTag . . . . . ............ 555 GetPOPExpirations . . . . . . . . . . . . . . . 253
Hosted Microsoft Exchange GetPOPForwarding . . . . . . . . . . . . . . . 256
HE_CancelAccount . . ............ 309 HE_CancelAccount . . . . . . . . . . . . . . . 309
HE_ChangePassword . ............ 312 HE_ChangePassword . . . . . . . . . . . . . 312
HE_CreateAccount . . . ............ 315 HE_CreateAccount . . . . . . . . . . . . . . . 315
HE_GetAccountDetails ............ 318 HE_GetAccountDetails . . . . . . . . . . . . . 318
HE_GetAccounts . . . . ............ 321 HE_GetAccounts . . . . . . . . . . . . . . . . 321
HE_GetPricing . . . . . . ............ 324 HE_GetPricing . . . . . . . . . . . . . . . . . . 324
HE_UpgradeAccount . ............ 327 HE_UpgradeAccount . . . . . . . . . . . . . . 327
hosting ModifyPOP3 passwords . . . . . . . . . . . . 338
DeleteHostedDomain . . . . . . . . . . . . . 97 PE_GetPOPPrice . . . . . . . . . . . . . . . . 353
ExtendDomainDNS . . . . . . . . . . . . . . 123 PurchasePOPBundle . . . . . . . . . . . . . . 393
PurchaseHosting . . . . . . . . . . . . . . . . 389 RenewPOPBundle . . . . . . . . . . . . . . . 421
SetCatchAll . . . . . . . . . . . . . . . . . . . . 439
I SetDotNameForwarding . . . . . . . . . . . . 453
identity SetPakRenew . . . . . . . . . . . . . . . . . . 458
AddContact . . . . . . .............. 18 SetPOPForwarding . . . . . . . . . . . . . . . 462
Contacts . . . . . . . . .............. 77 SetUpPOP3User . . . . . . . . . . . . . . . . . 480
DeleteContact . . . . .............. 91 mailboxes
GetAddressBook . . .............. 137 retrieving . . . . . . . . . . . . . . . . . . . . . . 249
GetContacts . . . . . .............. 160 managing domains
GetServiceContact . .............. 279 CheckNSStatus . . . . . . . . . . . . . . . . . 72
validating . . . . . . . .............. 69 GetAllDomains . . . . . . . . . . . . . . . . . . 144
identity protection GetDomainCount . . . . . . . . . . . . . . . . 177
DisableServices . . . .............. 111 GetDomainExp . . . . . . . . . . . . . . . . . . 180
EnableServices . . . .............. 113 GetDomainInfo . . . . . . . . . . . . . . . . . . 182
GetWPPSInfo . . . . .............. 306 GetDomains . . . . . . . . . . . . . . . . . . . . 189
PurchaseServices . .............. 399 GetDomainStatus . . . . . . . . . . . . . . . . 201
RenewServices . . . .............. 425 GetExpiredDomains . . . . . . . . . . . . . . . 208
ServiceSelect . . . . .............. 436 GetExtendInfo . . . . . . . . . . . . . . . . . . 215
InsertNewOrder . . . . . . .............. 330 GetHomeDomainList . . . . . . . . . . . . . . 230
IP address update GetPasswordBit . . . . . . . . . . . . . . . . . 247
SetDNSHost . . . . . . . . . . . . . . . . . . . 445 GetRegistrationStatus . . . . . . . . . . . . . 262
items GetRegLock . . . . . . . . . . . . . . . . . . . . 264
DeleteFromCart . . . . . . . . . . . . . . . . . 95 GetRenew . . . . . . . . . . . . . . . . . . . . . 267
Purchase . . . . . . . . . . . . . . . . . . . . . 380 GetSubAccountPassword . . . . . . . . . . . 288
PushDomain . . . . . . . . . . . . . . . . . . . 408
L renewals . . . . . . . . . . . . . . . . . . . . . . 215
locking domains SetPakRenew . . . . . . . . . . . . . . . . . . 458
GetRegLock . . . . . . . . . . . . . . . . . . . 264 SetPassword . . . . . . . . . . . . . . . . . . . 460
3/13/09 589
©2003-2009 Register.com, Inc. Index:
3/13/09 590
©2003-2009 Register.com, Inc. Index:
3/13/09 591
©2003-2009 Register.com, Inc. Index:
3/13/09 592
©2003-2009 Register.com, Inc. Index:
3/13/09 593
©2003-2009 Register.com, Inc. Index:
WSC_GetAllPackages . . . . . . . . . . . . 575
WSC_GetPricing . . . . . . . . . . . . . . . . 579
WSC_Update_Ops . . . . . . . . . . . . . . . 582
Web Site Creator
create, enable, disable . . . . . . . . . . . . 436
WebSite Creator
WSC_GetAccountInfo . ............ 570
WSC_GetAllPackages ............ 575
WSC_GetPricing . . . . ............ 579
WSC_Update_Ops . . . ............ 582
WhoIs
GetContacts . . . . . . . . . . . . . . . . . . . 160
GetWhoisContact . . . . . . . . . . . . . . . . 303
whois
AddContact . . . . . . . . . . . . . . . . . . . . 18
DeleteContact . . . . . . . . . . . . . . . . . . 91
GetAddressBook . . . . . . . . . . . . . . . . 137
WhoIs protection
DisableServices . . . . . ............ 111
EnableServices . . . . . ............ 113
GetWPPSInfo . . . . . . ............ 306
RenewServices . . . . . ............ 425
ServiceSelect . . . . . . ............ 436
Whois protection
PurchaseServices . . . . . . . . . . . . . . . 399
WSC stand-alone
WSC_GetAccountInfo . ............ 570
WSC_GetAllPackages ............ 575
WSC_GetPricing . . . . ............ 579
WSC_Update_Ops . . . ............ 582
WSC_GetAccountInfo . . . . ............ 570
WSC_GetAllPackages. . . . ............ 575
WSC_GetPricing . . . . . . . ............ 579
WSC_Update_Ops . . . . . . ............ 582
3/13/09 594