Param name Definition

Service Name of the service being disabled ServiceStatus New status of this service

Command Name of command executed

ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

Err(x) Error messages explaining the failure. These can be presented as is back to the client.

Done True indicates this entire response has reached you successfully.

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&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition Max

size

UID Required Account login ID 20

PW Required Account password 20

SLD Required Second-level domain name (for example, register in register.com)

TLD Required Top-level domain name (extension) 15

Service Required Name of the service to be enabled. Permitted values are:

WPPS (RCOM Shield, our Whois privacy protection service)

EmailForwarding URLForwarding

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

XML. 4

Returned parameters and values

Notes

• The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.

• Check the return parameter ErrCount. If greater than 0 the 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>

Param name Definition

Service Name of the service being enabled ServiceStatus New status of this service

Command Name of command executed

ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

Err(x) Error messages explaining the failure. These can be presented as is back to the client.

Done True indicates this entire response has reached you successfully.

Related commands

AddToCart DisableServices GetWPPSInfo PurchaseServices ServiceSelect SetRenew

SetResellerServicesPricing UpdateAccountPricing

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&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition Max

size

UID Required Account login ID 20

PW Required Account password 20

SLD Required Second-level domain name (for

example, register in register.com)

TLD Required Top-level domain name (extension) 15

NumYears Optional Number of years to extend 10

OverrideOrder Optional Use OverrideOrder=1 to submit more than one renewal request for this domain name within 24 hours of the first transaction

UseCreditCard Optional If UseCreditCard=yes, use

EndUserIP Required if

UseCreditCard

=yes

End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.

ChargeAmount Required if

UseCreditCard

=yes

Amount to charge per year for the renewal. Use DD.cc format.

CardType Required if

UseCreditCard

=yes

Type of credit card 20

CCName Required if

UseCreditCard

=yes

Cardholder's name 60

CreditCardNumber Required if UseCreditCard

=yes

Customer's credit card number 128

CreditCardExpMonth Required if UseCreditCard

=yes

Credit card expiration month 2

CreditCardExpYear Required if UseCreditCard

=yes

Credit card expiration year 4

CVV2 Required if

UseCreditCard

=yes

Credit card verification code 4

CCAddress Required if

UseCreditCard

=yes

Credit card billing address 60

CCZip Required if

UseCreditCard

=yes

Credit card billing postal code 15

CCCountry Required if

UseCreditCard

=yes

Credit card billing country 60

RegistrantFirstName Required if UseCreditCard

=yes

Registrant first name 60

RegistrantLastName Required if UseCreditCard

=yes

Registrant last name 60

RegistrantAddress1 Required if UseCreditCard

=yes

Registrant address 60

RegistrantAddress2 Optional Registrant additional address info 60 RegistrantCity Required if

UseCreditCard

=yes

Registrant city 60

RegistrantStateProvinceChoice Optional Registrant state or province choice:

S state P province

RegistrantStateProvince Required if UseCreditCard

=yes

Registrant state or province 60

Param name Obligation Definition Max

size

Returned parameters and values

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.

RegistrantPostalCode Required if UseCreditCard

=yes

Registrant postal code 16

RegistrantCountry Required if UseCreditCard

=yes

Registrant country 60

RegistrantEmailAddress Required if UseCreditCard

=yes

Registrant email address 128

RegistrantOrganizationName Optional Registrant organization 60

RegistrantJobTitle Optional Registrant job title 60

RegistrantPhone Required if UseCreditCard

=yes

Registrant phone number. Required format is

+CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.

RegistrantFax Optional Registrant fax number. Required format is

+CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.

ResponseType Optional Format of response. Options are Text

(default), HTML, or XML. 4

Param name Definition

RegistrarHold The enabled status of a domain. If RegistrarHold is True, the domain is disabled.

OrderID Order number if successful. We recommend that you store this value for future use.

Extension Returns Successful, otherwise this parameter isn't returned.

RRPCode Success code. Only a 200 indicates success.

RRPText Text which accompanies and describes the RRPCode.

Command Name of command executed

ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

Err(x) Error messages explaining the failure. These can be presented as is back to the client.

Done True indicates this entire response has reached you successfully.

Param name Obligation Definition Max

size

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

In document null (Page 112-120)