GetCusPreferences
Definition
Retrieve global preferences for an account.
Usage
Use this command to retrieve global preferences for an account.
Availability
All resellers have access to this command.
Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
https://resellertest.enom.com/myaccount/Settings.asp
On the settings page, many of the settings shown can be retrieved using GetCusPreferences.
Constraints
The query must meet the following requirements:
- The login ID and password must be valid.
- The domain name must belong to this account.
Input parameters
Build the query string using this syntax:
https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
¶mname=paramvalue&nextparamname=nextparamvalue
| Parameter | Status | Description | Max Size |
|---|---|---|---|
| UID | Required | Account login ID | 20 |
| PW | Required | Account password | 20 |
| ResellerKey | Optional | Reseller EC key for this Instant Reseller or Registry Rocket site, if different from this UID | 40 |
| ResellerStatus | Optional | ResellerStatus=1 retrieves information about Registry Rocket sites and reseller balances | 1 |
| ResponseType | Optional | Format of response. Permitted values are Text (default), HTML, or XML. | 4 |
Returned parameters and values
| Parameter | Description |
|---|---|
| DefPeriod | Default period for registrations, renewals, and transfers, in years |
| AllowDNS | True allows name servers other than eNom’s |
| ShowPopUps | True shows pop-up menus |
| AutoRenew | True automatically renews the domain 30 days before it expires |
| RegLock | True requires the account holder’s permission to transfer the domain to another registrar |
| AutoPakRenew | True automatically renews POP paks 30 days before they expire. |
| UseDNS | True uses eNom’s name servers |
| ResellerStatus | Is this a reseller account. |
| RenewalSetting | 0 indicates no email; 1 indicates send notice; 2 indicates contact and charge customer |
| RenewalBCC | 1 indicates send copy of email to reseller; 0 indicates no copy to reseller |
| RenewalURLForward | True automatically renews URL forwarding 30 days before the URL forwarding subscription expires. |
| RenewalEMailForward | True automatically renews email forwarding 30 days before the email forwarding subscription expires. |
| HostName | Name of this default host record |
| Address | Address of this default host record |
| RecordType | Record type of this default host record |
| DefaultHostRecordOwn | Is this account using its own set of default host records? |
| UseOurDNS | Does this account use eNom’s DNS servers by default? |
| DNSX | Default DNS server X for this domain name account |
| AcceptTerms | True indicates this account has signed a credit-card processing agreement with us |
| URL | URL for reseller site listed in email notices |
| ParentAccount | This account’s parent |
| NoService | Service status |
| BulkRegLimit | Maximum number of names this account can register in a single query |
| ResellerKey | Reseller key for this Registry Rocket site |
| HostPrice | Price this Registry Rocket account charges for DNS hosting |
| CCPrice | Price this Registry Rocket account charges for .cc |
| InfoPrice | Price this Registry Rocket account charges for .info |
| PictureURL | URL of image file used in this Registry Rocket site |
| ContactEmail | Contact email address for this Registry Rocket account |
| CompanyName | Company name for this Registry Rocket account |
| Referrer | Referrer for this Registry Rocket account |
| Balance | Current balance for this reseller account |
| BalanceThreshold | Balance threshold for this reseller account |
| Price | Wholesale price this account pays for .com |
| CCPrice | Wholesale price this account pays for .cc |
| AvailableBalance | Available balance for this account |
| ResCustomerPrice | ? |
| CommissionBalance | Current commission balance for this account |
| NotifyAmount | Send a notification email to the Billing contact for this account when available balance drops below this amount |
| Command | Name of command executed |
| ErrCount | The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. |
| ErrX | Error messages explaining the failure. These can be presented as is back to the client. |
| Done | True indicates this entire response has reached you successfully. |
Notes
- The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
- Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
Example
XML format example:
The following query retrieves the account settings for resellid and sends the response in XML format:
Query
https://resellertest.enom.com/interface.asp?
command=GetCusPreferences&uid=resellid&pw=resellpw
&responsetype=xml
The response is as follows:
Output
<interface-response>
<CustomerPrefs>
<DefPeriod>1</DefPeriod>
<AllowDNS>False</AllowDNS>
<ShowPopups>False</ShowPopups>
<AutoRenew>False</AutoRenew>
<RegLock>False</RegLock>
<AutoPakRenew>False</AutoPakRenew>
<UseDNS>True</UseDNS>
<ResellerStatus/>
<RenewalSetting>1</RenewalSetting>
<RenewalBCC>1</RenewalBCC>
<RenewalURLForward>False</RenewalURLForward>
<RenewalEmailForward>False</RenewalEmailForward>
<MailNumLimit>100</MailNumLimit>
<IDProtect>False</IDProtect>
<DefIDProtectRenew>False</DefIDProtectRenew>
<DefWBLRenew>False</DefWBLRenew>
<NameJetSales>False</NameJetSales>
<defaulthostrecords>
<hostrecord hostname="@" address="69.25.142.5" recordtype="A"/>
<hostrecord hostname="*" address="69.25.142.5" recordtype="A"/>
<hostrecord hostname="www" address="69.25.142.5" recordtype="A"/>
<hostrecord hostname="" address="" recordtype="A"/>
<hostrecord hostname="" address="" recordtype="A"/>
</defaulthostrecords>
<defaulthostrecordown>False</defaulthostrecordown>
<UseOurDNS>False</UseOurDNS>
<NameServers>
<DNS1>ns1.nicmus.com</DNS1>
<DNS2>ns2.nicmus.com</DNS2>
<DNS3>ns3.nicmus.com</DNS3>
</NameServers>
</CustomerPrefs>
<CustomerInformation>
<AcceptTerms>True</AcceptTerms>
<URL/>
<ParentAccount>000-00-0000</ParentAccount>
<ParentLogin>Main-eNom</ParentLogin>
<NoService>False</NoService>
<BulkRegLimit>100</BulkRegLimit>
<Account>217-no-0647</Account>
</CustomerInformation>
<Command>GETCUSPREFERENCES</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod/>
<MaxPeriod>10</MaxPeriod>
<Server>SJL21WRESELLT01</Server>
<Site>eNom</Site>
<IsLockable/>
<IsRealTimeTLD/>
<TimeDifference>+0.00</TimeDifference>
<ExecTime>0.219</ExecTime>
<Done>true</Done>
<RequestDateTime>12/8/2011 3:56:24 AM</RequestDateTime>
<debug></debug>
</interface-response>
HTML format example:
The following query retrieves the account settings for resellid and sends the response in HTML format:
Query
https://resellertest.enom.com/interface.asp?
command=GetCusPreferences&uid=resellid&pw=resellpw
&responsetype=html
The response is as follows:
Output
;URL Interface
;Machine is SJL0VWRESELL_T
;Encoding Type is utf-8
DefPeriod: 1
AllowDNS: False
ShowPopups: False
AutoRenew: True
RegLock: False
AutoPakRenew: False
UseDNS: True
ResellerStatus:
RenewalSetting: 1
RenewalBCC: 0
RenewalURLForward: False
RenewalEmailForward: False
MailNumLimit: 100
IDProtect: False
DefIDProtectRenew: False
DefWBLRenew: False
NameJetSales: False
hostname1: @
address1: 85.92.87.178
recordtype1: A
hostname2: *
address2: 85.92.87.179
recordtype2: A
hostname3: www
address3: 85.92.87.180
recordtype3: A
hostrecordcount: 3
defaulthostrecordown: True
UseOurDNS: True
DNS1: dns1.name-services.com
DNS2: dns2.name-services.com
DNS3: dns3.name-services.com
DNS4: dns4.name-services.com
DNS5: dns5.name-services.com
DNSCount: 5
AcceptTerms: True
URL:
ParentAccount: 000-00-0000
ParentLogin: Main-eNom
NoService: False
BulkRegLimit: 100
Account: 217-no-0647
Command: GETCUSPREFERENCES
APIType: API
Language: eng
ErrCount: 0
ResponseCount: 0
MinPeriod:
MaxPeriod: 10
Server: SJL0VWRESELL_T
Site: eNom
IsLockable:
IsRealTimeTLD:
TimeDifference: +0.00
ExecTime: 0.125
Done: true
RequestDateTime: 2/3/2015 4:58:52 PM
Text format example:
The following query retrieves the account settings for resellid and sends the response in Text format:
Query
https://resellertest.enom.com/interface.asp?
command=GetCusPreferences&uid=resellid&pw=resellpw
&responsetype=text
The response is as follows:
Output
;URL Interface
;Machine is SJL0VWRESELL_T
;Encoding Type is utf-8
DefPeriod=1
AllowDNS=False
ShowPopups=False
AutoRenew=True
RegLock=False
AutoPakRenew=False
UseDNS=True
ResellerStatus=
RenewalSetting=1
RenewalBCC=0
RenewalURLForward=False
RenewalEmailForward=False
MailNumLimit=100
IDProtect=False
DefIDProtectRenew=False
DefWBLRenew=False
NameJetSales=False
hostname1=@
address1=85.92.87.178
recordtype1=A
hostname2=*
address2=85.92.87.179
recordtype2=A
hostname3=www
address3=85.92.87.180
recordtype3=A
hostrecordcount=3
defaulthostrecordown=True
UseOurDNS=True
DNS1=dns1.name-services.com
DNS2=dns2.name-services.com
DNS3=dns3.name-services.com
DNS4=dns4.name-services.com
DNS5=dns5.name-services.com
DNSCount=5
AcceptTerms=True
URL=
ParentAccount=000-00-0000
ParentLogin=Main-eNom
NoService=False
BulkRegLimit=100
Account=217-no-0647
Command=GETCUSPREFERENCES
APIType=API
Language=eng
ErrCount=0
ResponseCount=0
MinPeriod=
MaxPeriod=10
Server=SJL0VWRESELL_T
Site=eNom
IsLockable=
IsRealTimeTLD=
TimeDifference=+0.00
ExecTime=0.063
Done=true
RequestDateTime=2/3/2015 4:59:46 PM