API Commands Reseller Partners

Transcription

1 API Commands Reseller Partners API Version 6.9 Revision Date: 21 st August 2014

2 Contents Commands... 3 useradd... 3 usermodify... 5 userget... 7 usersuspend... 9 domainadd domaincancel domaincheck domainget domainmodify domainrenew domainrestore domaintransferin domaintransfercancel domaintransferget domaintransferreason domaintransferresendapproval domaintransferupdateauthcode domaintagchange domainlock domainautorenew domainpassword domainpush registrycheck registryhostcheck registryhostdelete registryhostadd registryhostmodify domainprivacyadd domainprivacycancel domainprivacysuspend domainprivacyrenew I

3 domainprivacyautorenew domainhostingadd domainhostingcancel domainhostingget domainhostingrenew zoneadd zonedelete zoneoverwrite zoneget zonesubdomainget mailautorenew mailforwardadd mailforwarddelete mailforwardoverwrite mailforwardserviceadd mailforwardget hostingadd hostingcancel hostinglogin hostingproducttype hostingget hostingautorenew mailadd mailcancel mailproducttype mailget maillogin certificateadd certificateapproverget certificateconfigure certificatedelete certificateget certificateparsecsr certificatereconfigure certificateresend II

4 mobilehostingadd mobilehostingmodify mobilehostingautorenew mobilehostingcancel mobilehostingget mobilehostinglogin orderhistory shoppingcartcreate shoppingcartget shoppingcartitemdelete shoppingcartcheckout paymentcardonfilecreate paymentcardonfileget productconfigurationget ecommerceadd ecommerceautorenew ecommercecancel ecommerceget ecommerceproducttype ecommercelogin sitebuilderadd sitebuilderautorenew sitebuildercancel sitebuilderget sitebuildermodify mailpassword reportget contactadd contactget contactmodify sitesecurityadd sitesecurityautorenew sitesecurityget sitesecuritylogin difmautorenew III

5 difmsso difmget difmadd serviceadd domainapplicationadd domainapplicationget productinfoget domainapplicationsignmarkparse domainpremiumspin premiumdomainadd domainclaiminfo orderget poll pollack Appendices APPENDIX A Contact Fields APPENDIX B US State Codes APPENDIX C Country Codes APPENDIX D Supported Extensions APPENDIX E Extra Attributes APPENDIX F Error Codes APPENDIX G Web Server Types APPENDIX H Certificate Products APPENDIX I Hosting Products APPENDIX J Products APPENDIX K Card Types APPENDIX L ecommerce Products APPENDIX M Site Builder Products APPENDIX N Transfer Statuses APPENDIX O Product Statuses APPENDIX P User Account Statuses APPENDIX Q Report Types APPENDIX R Certificate Types APPENDIX S Site Security Product Types APPENDIX T DIFM Product Types IV

6 APPENDIX U Mobile Hosting Product Types APPENDIX V Certificate Validation Mode Types APPENDIX W Certificate Validation Info Nodes V

7 API Basics ACCESS & SECURITY The API service is provided securely over https. Every request is authenticated based on the combination of application key and authorised IP address. The applicationguid is the unique key assigned to each partner and is a mandatory parameter for all requests. If an invalid applicationguid is supplied then an HTTP 401 (unauthorised) error will be returned. When your partner account is first set-up you will be asked for one or more IP addresses from which your API requests will be received. This list can be changed by contacting partner support. If the applicationguid received within a request corresponds with one of the IP addresses that have been enabled for your key, then the request will be served. If IP authentication fails then an HTTP 403 (forbidden) error will be returned. XML predefines five entity references for special characters that would otherwise be interpreted as part of the mark-up language. These special characters must be used appropriately to insure proper parsing, interpretation, and data display. These five are listed as follows: Entity Reference & < < > > " &apos; Character & ' SERVICE URI The API service is available at the following address: Each request is a HTTP POST containing an XML string, with the root element servicerequest. XML element names are case sensitive. Request XML schemas are available here: USERS Products can optionally be assigned to a user record. This can be useful, for example, where a single user account in the client application owns multiple domain products and you would like to be able to retrieve all the products for a single user in one call in the future. For maximum simplicity, the user commands can be ignored. If this option is chosen then all products are assigned directly to the partner account, and the association between user and product is maintained in the client application only. Page 1

8 SERVICE Each request XML has a root servicerequest node. The first two child nodes are always command and client. The client node includes mandatory applicationguid element (as described above) and a clientref element. The clientref is a client reference identifier (up to 50 characters in length), supplied with every request. This identifier should be unique across all commands. It is suggested that this be in the form of a GUID. For example, the overall XML structure for a command would be as follows, the request-specific parameters are placed within the request node: <command></command> SERVICE Each API response is an XML string, with the root element serviceresponse. There are four possible response statuses: Code Description 1000 Success Failure 9998 Invalid XML 9999 Processing Service responses are in the following format: <serviceresponse> <command></command> <status> <statuscode></statuscode> <statusdescription></statusdescription> </status> <response></response> </serviceresponse> Page 2

9 Commands useradd Add a user against which to associate products. A content record of type Registration is required. An Administration contact may also be supplied. If an Administration contact is not supplied then the Registration record will be used as the default Administration contact. useraccountname is a concatenation of firstname and lastname if not supplied. Required Min Max userid Yes Identifier of the user account. Allows any alphanumeric character plus ampersand, period, underscore, hyphen. useraccountname Yes Friendly name for the account. This can be, but is not required to be the same value as the userid. contacts/ contact/ Yes * (repeated for Registration and/or Administration) * Supply full contact parameters (as per APPENDIX A Contact Fields) userid Identifier of the user account. Page 3

10 EXAMPLE <command>useradd</command> <userid>user123</userid> <useraccountname></useraccountname> <contacts> <contact> <firstname>domain</firstname> <lastname>registrar</lastname> <telephonenumber> </telephonenumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>fl</state> <postalcode>32258</postalcode> <countrycode>us</countrycode> <contacttype>registration</contacttype> </contact> </contacts> Page 4

11 usermodify Use this command to perform the following updates: I. Change useraccountname. II. Change a user s default registration and/or administration contacts (note that this is only applied to future domains/products added e.g. the existing WHOIS contacts for registered domains are not automatically updated). Required Min Max userid Identifier of the user account useraccountname Yes Friendly name for the account newuserid newuserpassword contacts/ the new UserId(will change the userid to this) The new Password(will change the password to this) contact/ Yes * (repeated for Registration and/or Administration) * Supply full contact parameters (as per APPENDIX A Contact Fields). userid Identifier of the user account. EXAMPLE <command>usermodify</command> <userid>user123</userid> <useraccountname>testname</useraccountname> <newuserid>user1234</newuserid> <newuserpassword>newpassword</newuserpassword> <contacts> <contact> <firstname>domain</firstname> <lastname>registrar</lastname> < address>[email protected]</ address> <telephonenumber> </telephonenumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>fl</state> <postalcode>32258</postalcode> <countrycode>us</countrycode> <contacttype>registration</contacttype> Page 5

12 </contact> </contacts> Page 6

13 userget Use this command to retrieve a user account details. Required userid page domainname Identifier of the user account. The page to return (can use if more than 25 users are returned). The domain name, e.g. example.com associated with the user account. users/ user/ userid useraccountname userpassword status contacts/ contact/ title firstname lastname companyname companypositionheld address telephonenumber faxnumber addressline1 addressline2 city province state postalcode countrycode contacttype Identifier of the user account. User account name. User account password. Contact status (See APPENDIX P User Account Statuses). Title of contact. First name of the contact. Last name of the contact. Company that the contact belongs to. Position contact holds at their company. address of contact. Telephone number of contact. Fax number of contact. First line of contact s address. Second line of card contact s address. City of contact. Province/County of contact. State of contact. Postal Code for the contact. 2-char ISO code of Country of contact s address (see APPENDIX C Country Codes). Type of contact (See APPENDIX A Contact Fields). Page 7

14 EXAMPLE <command>userget</command> <userid> </userid> <page>1</page> <domainname>example.com</domainname> Page 8

15 usersuspend Use this command to suspend a user account. Required userid Yes Identifier of the user account. suspend Yes Status of suspend e.g. TRUE or FALSE. Response will show the success of the suspension via the Status node in the standard API response. EXAMPLE <command>usersuspend</command> <userid>654321</userid> <suspend>true</suspend> Page 9

16 domainadd Register a new domain name, optionally assigned to a pre-defined user account. Whether or not a domain is set to automatically renew upon expiry depends on the global setting for your account (see also domainrenew and domaindelete). Where nameservers are supplied, zones are ignored. Where nameservers are supplied, there must be one primary and at least one secondary record. The relevant extraattributes required by the registry for the relevant domain extension must be supplied. Required Min Max userid Identifier of the user account. domainname Yes The domain name, e.g. example.com. term autorenew registrarlock contacts/ Yes Number of years for which the domain is to be registered. Allowed values vary by extension. Optional Boolean variable to override the account default setting Optional Boolean variable to override the account default transferlock setting contact/ Yes * nameservers/ nameserver (repeated for registration and/or administration contact) (repeated for each name server) nstype Yes Primary or Secondary. nsname Yes Name server URI, e.g. ns1.mynameserver.com. zones/ (only used where name servers not supplied) zone/ (repeated for each zone record) zonetype Yes Record type, e.g. A, CNAME, MX, TXT 1 5 zonekey Yes Sub-domain identifier, e.g. www. zonevalue Yes Record value, e.g extraattributes/ extraattribute/ (optional/mandatory depending on extension, see APPENDIX E Extra Attributes) (repeated for each required attribute) extraattributekey Yes Identifier for extended attribute field. extraattributevalue Yes Value to be assigned to the attribute. claimid To be specified if the domain has an Page 10

17 applicable claim within 90 days of the start of general availability. If you wish to perform an action on a allowpremium premium domain you have to set active consent otherwise the operation will fail * Supply full contact parameters (as per APPENDIX A Contact Fields). Page 11

18 Page 12 productid Identifier of the domain. EXAMPLE <command>domainadd</command> <userid></userid> <domainname>example.com</domainname> <term>1</term> <contacts> <contact> <title></title> <firstname>domain</firstname> <lastname>registrar</lastname> <companyname></companyname> <companypositionheld></companypositionheld> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>fl</state> <postalcode>32258</postalcode> <countrycode>us</countrycode> <contacttype>registration</contacttype> </contact> <contact> <title></title> <firstname>domain</firstname> <lastname>registrar</lastname> <companyname></companyname> <companypositionheld></companypositionheld> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>fl</state> <postalcode>32258</postalcode> <countrycode>us</countrycode> <contacttype>administration</contacttype> </contact> </contacts>

19 domaincancel For gtld domains, a 5 day cooling off period is available during which a domain purchase can be cancelled. If this command is received during this period, then the domain is removed and a refund is applied. Otherwise, the command will turn off automatic renewal of the domain. This effectively marks the domain for deletion upon expiration; unless it is manually renewed in the interim. Required userid userid associated to the domain productid Yes Identifier of the domain. productid Identifier of the domain. EXAMPLE <command>domaincancel</command> <productid> </productid> Page 13

20 domaincheck Use to determine whether a domain is available across one or more extensions. Required sld extensions/ extension checkoptions/ checkoption Yes Yes No The domain name. e.g. example in example.com. The domain extension. e.g. com in example.com. Extended result information to be returned if it s found at the registry. Options are Price and Claim. Both, either or neither options can be supplied. domain/ domainname domainavailable A domain name which has been checked. Availability result; Yes/No/Unknown. EXAMPLE <command>domaincheck</command> <clientref> </clientref> <sld>example</sld> <extensions> <extension>com</extension> <extension>net</extension> <extension>biz</extension> </extensions> <checkoptions> <checkoption>price</checkoption> <checkoption>claim</checkoption> </checkoptions> Page 14

21 domainget Use to query details for: i. One or more specific domains (include in domains node); or ii. All the domains associated with a user account (include userid and optionally page); or iii. All the domains associated with a partner (supply page only). Domains are returned in alphabetical sort sequence. Domains with a status of Deleted are not included in response unless specifically included in the request. 25 domains are returned per page. Required userid * Identifier of the user account. page * domains/ The page to return (can use if more than 25 domains meet request criteria). domainname * The domain name, e.g. example.com. * At least one of these must be provided: userid, page, or domainname (see above for details). currentpage totalpages recordcount domains/ domain/ userid domaininfo/ domainname productid domainstatus startdate expirydate autorenew registrarlock private password (all elements below are repeated for each domain returned) Identifier of associated user. The domain name, e.g. example.com. Identifier of the domain. Active, Expired, Redemption, Deleted or Not Found. The date on which the domain was registered in the system. Expiry date of the domain at the registry. Whether the domain is set to attempt automatic renewal before expiry. Lock status of the domain at the registry. Whether domain privacy has been activated. Domain password at the registry, for authentication purposes. Page 15

22 contacts/ contact/ nameservers/ nameserver/ zones/ zone/ extraattributes/ extraattribute/ Returns all the standard contact fields for each contact. Returns all the name server fields for each name server. Returns all the zone fields for each zone. Returns all the attribute fields for each attribute. EXAMPLE <command>domainget</command> <page>1</page> <domains> <domainname>example.com</domainname> </domains> Page 16

23 domainmodify Update any of the following details for a domain: i. Contact records for one or more contact types. ii. Name servers note that the full set of name servers must be provided for any change. All existing records will be deleted and replaced with those provided in this command. iii. Extra attributes where these have changed (for one or more attribute). Required productid Yes Identifier of the domain. contacts/ contact/ Yes * (repeated for registration and/or administration contact) nameservers/ nameserver/ (repeated for each name server) nstype Yes Primary or Secondary. nsname extraattributes/ extraattribute/ Yes Name server URI. e.g. ns1.mynameserver.com. (optional/mandatory depending on extension, see APPENDIX E Extra Attributes) (repeated for each required attribute) extraattributekey Yes Identifier for extended attribute field. extraattributevalue Yes Value to be assigned to the attribute. * Supply full contact parameters (as per APPENDIX A Contact Fields). productid Identifier of the domain. Page 17

24 Page 18 EXAMPLE <command>domainmodify</command> <productid></productid> <contacts> <contact> <title></title> <firstname>domain</firstname> <lastname>registrar</lastname> <companyname></companyname> <companypositionheld></companypositionheld> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>fl</state> <postalcode>32258</postalcode> <countrycode>us</countrycode> <contacttype>registration</contacttype> </contact> <contact> <title></title> <firstname>domain</firstname> <lastname>registrar</lastname> <companyname></companyname> <companypositionheld></companypositionheld> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>fl</state> <postalcode>32258</postalcode> <countrycode>us</countrycode> <contacttype>administration</contacttype> </contact> </contacts> <nameservers> <nameserver> <nstype>primary</nstype> <nsname>dns1.example.com</nsname> </nameserver> <nameserver> <nstype>secondary</nstype> <nsname>dns2.example.com</nsname> </nameserver> </nameservers>

25 domainrenew Use this command to renew a domain name prior to expiry or in expired status. A domain will typically renew automatically upon expiry; the domainrenew and domaincancel commands are used to specifically renew or delete a domain prior to expiry. With some domain registries, a domain is only open for renewal processing after a maximum number of days/month prior to expiry; this period varies by registry. Domains can never be extended for more than 10 years from the current date. Required shoppingcartid productid Yes Identifier of the domain. If the renewal is being processed via shopping cart checkout the Guid of the Shopping Cart can be specified. term Yes Number of years for which to extend the domain. userid allowpremium User Id the plan belongs to If you wish to perform an action on a premium domain you have to set active consent otherwise the operation will fail. True / False productid expirydate Identifier of the domain. The new expiry date for the domain. EXAMPLE <command>domainrenew</command> <productid> </productid> <term>2</term> Page 19

26 domainrestore This command is used to restore a domain when it expires. Restoring an expired domain is only permitted by certain Registries, typically the gtlds i.e. COM, NET etc The number of days in which it is possible to restore an expired domain may range between 0 90 days past the domain expiration date, depending on Registry rules. Required Min Max userid Identifier of a user account. productid Yes Identifier of the domain. allowpremium If you wish to perform an action on a premium domain you have to set active consent otherwise the operation will fail. True / False. productid Identifier of the domain. EXAMPLE <command>domainrestore</command> <productid> </productid> Page 20

27 domaintransferin Transfer a domain from another provider, optionally assigned to a pre-defined user account. Transfers are processed off-line. Poll domainget to confirm final result; if domain status is "Active" transfer has succeeded, else "TransferFailed". Up to five days should typically be allowed for the transfer process. Some registries extend the domain upon transfer (e.g. TLDs are treated in this way), in which case the expiry date will be updated for one year (charged as a renewal); otherwise the expiry date will not change. If contacts are supplied then these are used; otherwise default contacts are retained. The current name servers are retained during the transfer (this can be updated by domainmodify after transfer is complete). Required userid Identifier of the user account. domainname Yes Number of years for which to extend the domain. authcode contacts/ Authorization code at the registry. If this is not supplied in the initial request it may be added later if needed. contact/ Yes * (repeated for registration and/or administration contact) extraattributes/ extraattribute/ (optional/mandatory depending on extension, see APPENDIX E Extra Attributes) (repeated for each required attribute) extraattributekey Yes Identifier for extended attribute field. extraattributevalue Yes Value to be assigned to the attribute. Nameservers/ No This is required for.ro,.gr, and.es domains, and is ignored if supplied for other tlds nameserver No This is required for.ro,.gr, and.es domains, and is ignored if supplied for other tlds iana Used to specifiy registry credentials if the domain is not registered against the default credentials. allowpremium If you wish to perform an action on a premium domain you have to set active consent * Supply full contact parameters (as per APPENDIX A Contact Fields). productid Identifier of the domain. Page 21

28 Page 22 EXAMPLE <command>domaintransferin</command> <clientref> </clientref> <userid></userid> <domainname>example.com</domainname> <authcode></authcode> <contacts> <contact> <title></title> <firstname>domain</firstname> <lastname>registrar</lastname> <companyname></companyname> <companypositionheld></companypositionheld> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>ny</state> <postalcode>10018</postalcode> <countrycode>us</countrycode> <contacttype>registration</contacttype> </contact> <contact> <title></title> <firstname>domain</firstname> <lastname>registrar</lastname> <companyname></companyname> <companypositionheld></companypositionheld> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>ny</state> <postalcode>10018</postalcode> <countrycode>us</countrycode> <contacttype>administration</contacttype> </contact> </contacts>

29 domaintransfercancel Cancel a domain transfer that is pending. The productid supplied must relate to a domain in TransferPending status. Note, however, that some pending transfers may be too far progressed to cancel. Required productid Yes Identifier of the domain. productid Identifier of the domain. EXAMPLE <command>domaintransfercancel</command> <productid> </productid> Page 23

30 domaintransferget Use this command to retrieve a list of transfer affected domains. Required userid No Identifier of a user account. page The page to return (can use if more than 25 domain meet request criteria). domainname No* Interchangeable with productid, productid takes precedence domainstatuses/ No If no statuses are supplied all statuses will be queried domainstatus productid No* Status of a domain (See APPENDIX N Transfer Statuses). Interchangeable with domainname, productid will return a more specific result domains/ productid domainname initiateddate status statusdate recordcount numberofpages Identifier of the domain. Domain name. The date the transfer was initiated. The transfer status of the domain (See APPENDIX N Transfer Statuses). The date the status was set. EXAMPLE <command>domaintransferget</command> <clientref>test</clientref> <userid>testuser</userid> <page>1</page> <domainstatuses> <domainstatus>transferpending</domainstatus> </domainstatuses> <domainname>testtransferdomain.net</domainname> Page 24

31 domaintransferreason Use this command to retrieve a domain transfer reason for failure. Required productid Yes Identifier of the domain. productid reason Identifier of the domain. The reason for the transfer failure. EXAMPLE <command>domaintransferreason</command> <productid> </productid> Page 25

32 domaintransferresendapproval Use this command to resend a Transfer Approval to the current registrant. Required productid Yes Identifier of the domain. productid Identifier of the domain. EXAMPLE <command>domaintransferresendapproval </command> <productid> </productid> Page 26

33 domaintransferupdateauthcode Use this command to update a domains authorisation code at registry when a domain is in the TransferPendingAuthcode status. Required userid Identifier of a user account. productid Yes Identifier of the domain. authcode Yes New authorisation code for the domain. productid authcode Identifier of the domain. The domain authorisation code. EXAMPLE <command>domaintransferupdateauthcode</command> <productid> </productid> <authcode>auth123</authcode> Page 27

34 domaintagchange Change a domain's IPS Tag for transfers between registrars. Required productid Yes Identifier of the domain. registrartag Yes IPS Tag of the gaining registrar. productid Identifier of the domain. EXAMPLE <command>domaintagchange</command> <productid> </productid> <registrartag>register</registrartag> Page 28

35 domainlock Use this command to change the status of the lock at the registry for a domain. Required productid Yes Identifier of the domain. registrarlock Yes Status of the lock, e.g. True or False productid Identifier of the domain. EXAMPLE <command>domainlock</command> <productid> </productid> <registrarlock>true</registrarlock> Page 29

36 domainautorenew Use this command to change the status of auto renew for a domain. Required productid Yes Identifier of the domain. autorenew Yes Status of auto renew, e.g. True or False productid Identifier of the domain. EXAMPLE <command>domainautorenew</command> <productid> </productid> <autorenew>true</autorenew> Page 30

37 domainpassword Use this command to generate a new password for the domain. If a password already exists, this will be overwritten at the registry. Required productid Yes Identifier of the domain. generatepassword No Forces the authcode to be re-generated at the registry productid password Identifier of the domain. Generated domain password. EXAMPLE <command>domainpassword</command> <productid> </productid> <generatepassword>true</generatepassword> Page 31

38 domainpush Transfer a domain from one reseller to another reseller. The domain is not renewed when it is transferred and so no charges are incurred. Before you can push a domain to another reseller account, you must have authorization from the target reseller to use their reseller login identifier. Required userid Identifier of the target user account. productid Yes Identifier of the domain. resellerid Yes Identifier of the target reseller account. pushcontact Yes False - Do not push contact information with the domain. True - Push contact information with the domain. productid Identifier of the domain. EXAMPLE <command>domainpush</command> <userid></userid> <productid> </productid> <resellerid>target01</resellerid> <pushcontact>true</pushcontact> Page 32

39 registrycheck Use this command to retrieve the registry details for a domain. Required domainname Yes Domain name. name createtime expirytime updatetime nameserver registrystatus Domain name. The date the domain was created at the registry. The date the domain will expire at the registry. The date that the domain data was last updated at the registry. The name server of the domain. The status of the domain at the registry. EXAMPLE <command>registrycheck</command> <domainname>example.com</domainname> Page 33

40 registryhostcheck Use this command to verify whether a name server exists at a particular registry. Required nameserver/ nsname Yes Name server URI, ns1.mynameserver.com. e.g. nameserver/ nsname nsipaddress Name server URI, e.g. ns1.mynameserver.com. IP address of the name server. EXAMPLE <command>registryhostcheck</command> <nameserver> <nsname>ns1.mynameserver.com</nsname> </nameserver> Page 34

41 registryhostdelete Use this command to delete a nameserver that exists against a domain. The server you delete must be valid against the domain name that is in your account. The domain name is extracted from the provided nameserver. Required nameserver/ Yes nsname Yes Name server URI. e.g. ns1.mynameserver.com. ipaddress IP address of the name server. Only a success or failure is returned. n/a n/a EXAMPLE <command>registryhostdelete</command> <nameserver> <nsname>ns1.mynameserver.com</nsname> <ipaddress> </ipaddress> </nameserver> Page 35

42 registryhostadd Use this command to register one of your own servers as a domain name server. The server you register must use a domain name that is in your account. The registrar lock for the domain must be set to off while you register a name server. Required nameserver/ Yes nsname Yes Name server URI. e.g. ns1.mynameserver.com. ipaddress * IPV4 address the nameserver is being updated to, This should be supplied if IPV6 address is not supplied ipaddressv6 * IPV6 address the nameserver is being updated to, if This is supplied IPV4 address should not be supplied At least one of ipaddress and/or ipaddressv6 must be supplied. n/a n/a EXAMPLE <command>registryhostadd</command> <nameserver> <nsname>ns1.mynameserver.com</nsname> <ipaddress> </ipaddress> </nameserver> Page 36

43 registryhostmodify Use this command to update the IP associated to a nameserver. Required Min Max Nameserver/ Yes Container for the name server information 1 1 nsname Yes Name of the nameserver being updated 1 1 ipaddress No IPV4 address the nameserver is being updated to, This should be supplied if IPV6 address is not supplied 0 1 ipaddressv6 No IPV6 address the nameserver is being updated to, if This is supplied IPV4 address should not be supplied 0 1 Only a success or failure is returned. EXAMPLE <command>registryhostmodify</command> <clientref>test</clientref> <nameserver> <nsname>ns3.testregcom-gh a.com</nsname> <ipaddress> </ipaddress> <ipaddressv6></ipaddressv6> </nameserver> Page 37

44 domainprivacyadd Add privacy to an existing domain registration. Required productid Yes Identifier of the domain. term Yes Number of years for which the privacy is to be activated. productid Identifier of the domain. EXAMPLE <command>domainprivacyadd</command> <productid> </productid> <term>1</term> Page 38

45 domainprivacycancel This command will turn off automatic renewal of the domain privacy. This effectively marks the domain privacy subscription for deletion upon expiration; unless it is manually renewed in the interim. Required productid Yes Identifier of the domain privacy subscription. productid Identifier of the domain privacy subscription. EXAMPLE <command>domainprivacycancel</command> <productid> </productid> Page 39

46 domainprivacysuspend Use this command to toggle on or off the WHOIS privacy. Required productid Yes Identifier of the domain privacy subscription. private Yes Status of WHOIS privacy, e.g. True or False productid Identifier of the domain privacy subscription. EXAMPLE <command>domainprivacysuspend</command> <productid> </productid> <private>true</private> Page 40

47 domainprivacyrenew Use this command to renew a domain privacy service prior to the expiry date. Required productid Yes Identifier of the domain privacy subscription. term Yes Number of years for which to extend the domain privacy service. productid expirydate Identifier of the domain privacy subscription. The new expiry date for the domain privacy subscription. EXAMPLE <command>domainprivacyrenew</command> <productid> </productid> <term>2</term> Page 41

48 domainprivacyautorenew Use this command to change the auto-renew status of a domain s privacy. Required productid Yes Identifier of the domain. autorenew Yes Status of auto renew, e.g. TRUE or FALSE. productid Identifier of the domain. EXAMPLE <command>domainprivacyautorenew</command> <productid> </productid> <autorenew>true</autorenew> Page 42

49 domainhostingadd Subscribe to our domain name hosting services, while leaving the registration of the domain name at another registrar. Required Min Max userid Identifier of the user account. domainname Yes The domain name, e.g. example.com. term zones/ zone/ zonetype Yes Yes Number of years for which the domain hosting is to be billed. (optional) (repeated for each zone record) Record type, e.g. A, CNAME, MX, TXT zonekey Yes Sub-domain identifier, e.g. www. 1 5 zonevalue Yes Record value, e.g productid Identifier of the domain. EXAMPLE <command>domainhostingadd</command> <userid></userid> <domainname>example.com</domainname> <term>1</term> <zones> <zone> <zonetype>a</zonetype> <zonekey>www</zonekey> <zonevalue> </zonevalue> </zone> </zones> Page 43

50 domainhostingcancel This command will turn off automatic renewal of the domain hosting service. This effectively marks the domain hosting service subscription for deletion upon expiration; unless it is manually renewed in the interim. Required productid Yes Identifier of the domain hosting subscription. productid Identifier of the domain hosting subscription. EXAMPLE <command>domainhostingcancel</command> <productid> </productid> Page 44

51 domainhostingget Use to query details for: i. One or more specific domains (include in domains node); or ii. All the domains associated with a user account (include userid and optionally page); or iii. All the domains associated with a partner (supply page only). Domains are returned in alphabetical sort sequence. 25 domains are returned per page. Required userid * Identifier of the user account. page * domains/ The page to return (can use if more than 25 domains meet request criteria). domainname * The domain name, e.g. example.com. * At least one of these must be provided: userid, page, or domainname (see above for details). currentpage totalpages recordcount domains/ domain/ userid domainhostinginfo/ domainname productid domainhostingstatus startdate expirydate autorenew zones/ zone/ (all elements below are repeated for each domain returned) Identifier of associated user. The domain name, e.g. example.com. Identifier of the domain hosting subscription. Active, Expired, Redemption, Deleted or Not Found. The date on which the domain hosting subscription started. Expiry date of the domain hosting subscription. Whether the subscription is set to automatically renew before expiry. Returns all the zone fields for each zone. Page 45

52 EXAMPLE <command>domainhostingget</command> <page>1</page> <domains> <domainname>example.com</domainname> </domains> Page 46

53 domainhostingrenew Use this command to renew a domain hosting service prior to the expiry date. Required productid Yes Identifier of the domain hosting subscription. term Yes Number of years for which to extend the domain hosting service. productid expirydate Identifier of the domain hosting subscription. The new expiry date for the domain hosting subscription. EXAMPLE <command>domainhostingrenew</command> <productid> </productid> <term>2</term> Page 47

54 zoneadd Create a zone record associated with a domain hosted on our DNS service. Required Min Max productid Yes Identifier of the domain. zones/ zone/ zonetype Yes (repeated for each zone record) Record type, e.g. A, CNAME, MX, TXT zonekey Yes Sub-domain identifier, e.g. www. 1 5 zonevalue Yes Record value, e.g productid Identifier of the domain. EXAMPLE <command>zoneadd</command> <productid> </productid> <zones> <zone> <zonetype>a</zonetype> <zonekey>www</zonekey> <zonevalue> </zonevalue> </zone> </zones> Page 48

55 zonedelete Remove a zone record associated with a domain hosted on our DNS service. Deletes zone record where the zonetype and zonekey match an existing record (or for MX type records, where zonetype and zonevalue match). Required Min Max productid Yes Identifier of the domain. zones/ zone/ zonetype Yes (repeated for each zone record) Record type, e.g. A, CNAME, MX, TXT zonekey Yes Sub-domain identifier, e.g. www. 1 5 zonevalue Yes Record value, e.g productid Identifier of the domain. EXAMPLE <command>zonedelete</command> <productid> </productid> <zones> <zone> <zonetype>a</zonetype> <zonekey>www</zonekey> <zonevalue> </zonevalue> </zone> </zones> Page 49

56 zoneoverwrite Changes zone records associated with a domain hosted on our DNS service. This command deletes all the existing host records before replacing them with the host records included in the request. We advise you to use the zoneget to retrieve all existing records, and populate the zoneoverwrite with these records while making the appropriate changes. Required Min Max productid Yes Identifier of the domain. zones/ zone/ zonetype Yes (repeated for each zone record) Record type, e.g. A, CNAME, MX, TXT zonekey Yes Sub-domain identifier, e.g. www. 1 5 zonevalue Yes Record value, e.g productid Identifier of the domain. EXAMPLE <command>zoneoverwrite</command> <productid> </productid> <zones> <zone> <zonetype>a</zonetype> <zonekey>www</zonekey> <zonevalue> </zonevalue> </zone> </zones> Page 50

57 zoneget Retrieves list of zone records associated with a domain hosted on our DNS. Required productid Yes Identifier of the domain. productid zones/ zone/ zonetype zonekey Identifier of the domain. (repeated for each zone record) Record type, e.g. A, CNAME, MX, TXT Sub-domain identifier, e.g. www. zonevalue Record value, e.g EXAMPLE <command>zoneget</command> <productid> </productid> Page 51

58 zonesubdomainget Use this command to retrieve a list of sub-domains against a domain product. Required productid Yes Identifier of the domain. page subdomain The page to return (can use if more than 25 sub-domains meet the request criteria). Specific sub-domain name. subdomains/ subdomain (all elements below are repeated for each sub-domain returned) Sub domain name. EXAMPLE <command>zonesubdomainget</command> <productid> </productid> <page>1</page> <subdomain>subdomain.example.com</subdomain> Page 52

59 mailautorenew Use this command to change the status of auto renew for an package. Required productid Yes Identifier of the package. autorenew Yes Status of auto renew, e.g. TRUE or FALSE. productid Identifier of the package. EXAMPLE <command>mailautorenew</command> <productid> </productid> <autorenew>true</autorenew> Page 53

60 mailforwardadd Create an forwarding record associated with a domain hosted on our DNS service. Required productid Yes Identifier of the domain. mailforwardrules/ mailforwardrule/ Yes (repeated for each forwarding record) key Yes Address (mailbox user name) to be forwarded from this domain. address Yes address to receive forwarded mail. productid Identifier of the domain. EXAMPLE <command>mailforwardadd</command> <productid> </productid> <mailforwardrules> <mailforwardrule> <key>postmaster</key> < address>[email protected]</ address> </mailforwardrule> </mailforwardrules> Page 54

61 mailforwarddelete Remove an forwarding record associated with a domain hosted on our DNS service. Deletes zone record where the key and address match an existing record. Required productid Yes Identifier of the domain. mailforwardrules/ mailforwardrule/ key Yes (repeated for each forwarding record) Address (mailbox user name) to be forwarded from this domain. productid Identifier of the domain. EXAMPLE <command>mailforwarddelete</command> <productid> </productid> <mailforwardrules> <mailforwardrule> <key>postmaster</key> < address>[email protected]</ address> </mailforwardrule> </mailforwardrules> Page 55

62 mailforwardoverwrite Changes forwarding records associated with a domain hosted on our DNS service. This command deletes all the existing forwarding records before replacing them with the forwarding records included in the request. We advise you to use the mailforwardget to retrieve all existing records, and populate the mailforwardoverwrite with these records while making the appropriate changes. Required productid Yes Identifier of the domain. mailforwardrules/ mailforwardrule/ key Yes (repeated for each forwarding record) Address (mailbox user name) to be forwarded from this domain. address Yes address to receive forwarded mail. productid Identifier of the domain. EXAMPLE <command>mailforwardoverwrite</command> <productid> </productid> <mailforwardrules> <mailforwardrule> <key>postmaster</key> < address>[email protected]</ address> </mailforwardrule> </mailforwardrules> Page 56

63 mailforwardserviceadd This command adds the specified mail forwarding rules to the domain provided on the request. Required domainname Yes The domain to which the mail forward rules will be added. mailforwardrules/ mailforward/ (repeated for each forwarding record) Key Yes Address (mailbox user name) to be forwarded from this domain. address Yes address to receive forwarded mail. productid Identifier of the domain. EXAMPLE <command>mailforwardserviceadd</command> <domainname>example.com</domainname> <mailforwardrules> <mailforward> <key>postmaster</key> </mailforward> </mailforwardrules> Page 57

64 mailforwardget Retrieves list of forwarding records associated with a domain hosted on our DNS. Required productid Yes Identifier of the domain. productid mailforwardrules/ mailforward/ key address Identifier of the domain. (repeated for each forwarding record) Address (mailbox user name) to be forwarded from this domain. address to receive forwarded mail. EXAMPLE <command>mailforwardget</command> <productid> </productid> Page 58

65 hostingadd Purchase a new hosting package, optionally assigned to a pre-defined user account. Required shoppingcartid userid Identifier of the shopping cart. Identifier of the user account. domainname Yes The domain name, e.g. example.com. term Yes Term of the hosting package subscription in months, e.g. 1 producttype Yes Type of hosting package (APPENDIX I Hosting Products). updatedns Yes Update available DNS records, e.g. True or False productid password ipaddress Identifier of the hosting package. Unique password associated with the hosting package. IP address of the hosting server package. EXAMPLE <command>hostingadd</command> <userid>testuser</userid> <term>1</term> <producttype>linuxhosting-economy</producttype> <domainname>example.com</domainname> <updatedns>false</updatedns> Page 59

66 hostingcancel Use this command to cancel a hosting package subscription. Cancellation of a hosting package changes the status from Active to Cancelled. Once an Active package is cancelled it continues to be available until the current subscription period lapses. Required productid Yes Identifier of the hosting package. productid Identifier of the hosting package. EXAMPLE <command>hostingcancel</command> <productid> </productid> Page 60

67 hostinglogin Use this command to return a URL that can be used to single sign on to the hosting management UI. Required productid Yes Identifier of the hosting package. productid singlesignonurl Identifier of the hosting package. URL used to Sign into the hosting account EXAMPLE <command>hostinglogin</command> <productid> </productid> Page 61

68 hostingproducttype Use this command to upgrade or downgrade the hosting package type (i.e. between Lite, Business and Professional ). The subscription cost for the associated hosting package is updated and applied starting from the next renewal date. Required productid Yes Identifier of the hosting package. producttype Yes Type of the new hosting package, e.g. Professional, Business or Lite productid Identifier of the hosting package. EXAMPLE <command>hostingproducttype</command> <productid> </productid> <producttype>lite</producttype> Page 62

69 hostingget Use to query details for: i. One or more specific domains associated with the hosting packages (include in domains node); or ii. All the hosting packages associated with a user account (include userid and optionally page); or iii. All the hosting packages associated with a partner (supply page only). Hosting packages with a status of Deleted are not included in response unless specifically included in the request. 25 hosting packages are returned per page. Required userid * Identifier of the user account. page * domains/ The page to return (can use if more than 25 hosting packages meet request criteria). The domain name, e.g. example.com associated with the hosting domainname * package. * At least one of these must be provided: userid, page, or domainname (see above for details). currentpage totalpages recordcount products/ product/ userid hostinginfo/ domainname productid hostingstatus producttype startdate expirydate ipaddress (all elements below are repeated for each hosting package returned) Identifier of associated user. The domain name, e.g. example.com. Identifier of the hosting package. Active, Cancelled, Deleted or Not Found. Type of hosting package. The date on which the hosting package commenced. Expiry date of the hosting package subscription. IP address of the hosting server package. Page 63

70 EXAMPLE <command>hostingget</command> <page>1</page> <domains> <domainname>example.com</domainname> </domains> Page 64

71 hostingautorenew Use this command to change the status of auto renew for a hosting package. Required productid Yes Identifier of the hosting package. autorenew Yes Status of auto renew, e.g. TRUE or FALSE. productid Identifier of the hosting package. EXAMPLE <command>hostingautorenew</command> <productid> </productid> <autorenew>true</autorenew> Page 65

72 mailadd Purchase a new mail package, optionally assigned to a pre-defined user account. Required shoppingcartid userid Identifier of the shopping cart. Identifier of the user account. domainname Yes The domainname to associate to the service term Yes Term of the mail package subscription in months, e.g. 1 producttype Yes Type of mail package (APPENDIX J Products) updatedns Yes Value to indicate if the zone settings should be modified as part of the purchase. E.g true or false productid password servername Identifier of the mail package. Unique password associated with the mail package. Server name for POP/IMAP of the mail package. EXAMPLE <command>mailadd</command> <userid>testuser</userid> <term>1</term> <producttype> 500m</producttype> <domainname>test.com</domainname> <updatedns>true</updatedns> Page 66

73 mailcancel Use this command to cancel a mail package subscription. Cancellation of a mail package changes the status from Active to Cancelled. Once an Active package is cancelled it continues to be available until the current subscription period lapses. Required productid Yes Identifier of the hosting package. productid Identifier of the hosting package. EXAMPLE <command>mailcancel</command> <productid> </productid> Page 67

74 mailproducttype Use this command to upgrade or downgrade the mail package type (i.e. between 100M, 500M, 5G and 10G ). The subscription cost for the associated mail package is updated and applied starting from the next renewal date. Required productid Yes Identifier of the mail package. producttype Yes Type of mail package, e.g. 100M, 500M, 5G or 10G productid Identifier of the mail package. EXAMPLE <command>mailproducttype</command> <productid> </productid> <producttype> 100m</producttype> Page 68

75 mailget Use to query details for: i. One or more specific domains associated with the mail packages (include in domains node); or ii. All the mail packages associated with a user account (include userid and optionally page); or iii. All the mail packages associated with a partner (supply page only). Mail packages with a status of Deleted are not included in response unless specifically included in the request. 25 mail packages are returned per page. Required userid * Identifier of the user account. page * domains/ The page to return (can use if more than 25 mail packages meet request criteria). The domain name, e.g. example.com associated with the mail domainname * package. * At least one of these must be provided: userid, page, or domainname (see above for details). currentpage totalpages recordcount products/ product/ userid mailinfo/ domainname productid mailstatus producttype startdate expirydate servername mailboxes (all elements below are repeated for each mail package returned) Identifier of associated user. The domain name, e.g. example.com. Identifier of the mail package. Active, Cancelled, Deleted or Not Found. Type of mail package. The date on which the mail package commenced. Expiry date of the mail package subscription. Server name for POP/IMAP of the mail package. Number of mailboxes associated with the mail package. Page 69

76 EXAMPLE <command>mailget</command> <page>1</page> <domains> <domainname>example.com</domainname> </domains> Page 70

77 maillogin Use this command to return a URL that can be used to single sign on to the management UI. Required productid Yes Identifier of the package. productid singlesignonurl Identifier of the package. URL used to Sign into the account EXAMPLE <command>maillogin</command> <productid> </productid> EXAMPLE <serviceresponse> <command>maillogin</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <response> <productid> </productid> <singlesignonurl> 9ff076b7fe09&utc=8/12/2013 1:35:57 PM&hash=ECF5A23D51FD DFF42A5B6 </singlesignonurl> </response> </serviceresponse> Page 71

78 certificateadd Purchase a new SSL certificate, optionally assigned to a pre-defined user account. Required userid term Yes Identifier of the user account. Number of months for which the certificate is to be registered. Allowed values vary by certificate type. producttype Yes Type of SSL certificate (APPENDIX H Certificate Products). productid Identifier of the SSL certificate. EXAMPLE <command>certificateadd</command> <userid></userid> <term>12</term> <producttype>ge-truebiz</producttype> Page 72

79 certificateapproverget Retrieve the addresses of qualified approvers for the domain name. Required productid Yes Identifier of the certificate. domainname Yes The domain name, e.g. example.com. approvers/ address address of approver. EXAMPLE <command>certificateapproverget</command> <clientref> </clientref> <productid> </productid> <domainname> Page 73

80 certificateconfigure Submit configuration information to certification authority for final issuance of the SSL certificate. Required productid Yes Identifier of the certificate. servertype Yes APPENDIX G Web Server Types certificatevalidationmode No APPENDIX V Certificate Validation Mode Types. Defaults to if not provided. approver address Yes address of approver. csr Yes Certificate Signing Request (CSR) code. contact/ Yes * (either registration or administration contact) * Supply full contact parameters (as per APPENDIX A Contact Fields). productid certificatevalidationinfo/ certificatevalidationmode certificatevalidation Identifier of the SSL certificate. This node is only visible if the Validation Mode is anything OTHER than (default) APPENDIX V Certificate Validation Mode Types APPENDIX W Certificate Validation Info Nodes Page 74

81 EXAMPLE <command>certificateconfigure</command> <productid> </productid> <servertype>aol</servertype> <certificatevalidationmode> </certificatevalidationmode> <csr> -----BEGIN NEW CERTIFICATE MIIDazCCAtQCAQAwfDELMAkGA1UEBhMCR0IxEDAOBgNVBAgMB2NhcmRpZmYxEDAO -----END NEW CERTIFICATE </csr> <contact> <firstname>domain</firstname> <lastname>registrar</lastname> <telephonenumber> </telephonenumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province> </province> <postalcode>10018</postalcode> <countrycode>us</countrycode> <contacttype>administration</contacttype> </contact> Page 75

82 certificatedelete Use this command to cancel a certificate subscription before it has finished the provisioning process. Cancellation of a certificate will delete and refund the certificate if it is in a state that allows the certificate to be deleted. Required productid Yes Identifier of the certificate package. productid Identifier of the certificate package. EXAMPLE <command>certificatedelete</command> <productid> </productid> Page 76

83 certificateget Use to query details for: i. One or more specific domains associated with the SSL certificates (include in domains node); or ii. All the SSL certificates associated with a user account (include userid and optionally page); or iii. All the SSL certificates associated with a partner (supply page only). SSL certificates with a status of Deleted are not included in response unless specifically included in the request. 25 SSL certificates are returned per page. Required userid * Identifier of the user account. page * domains/ The page to return (can use if more than 25 SSL certificates meet request criteria). The domain name, e.g. example.com associated with the domainname * SSL certificate. * At least one of these must be provided: userid, page, or domainname (see above for details). currentpage totalpages recordcount products/ product/ userid certificateinfo/ domainname productid certificatestatus producttype startdate expirydate approver csr (all elements below are repeated for each SSL certificate returned) Identifier of associated user. The domain name, e.g. example.com. Identifier of the SSL certificate. Certificate Issued, Processing, Deleted or Awaiting Configuration. Type of SSL certificate. The date the cert was configured/issued. Expiry date of the SSL certificate subscription. address of approver. Certificate Signing Request (CSR) code. Page 77

84 ca userloginid certificateissuerid certificatevalidationinfo/ certificatevalidationmode certificatevalidation SSL certificate, provided by the certificate authority. The LoginID of the associated User This node and all below are visible only if the Validation Mode provided was NOT (default) APPENDIX V Certificate Validation Mode Types APPENDIX W Certificate Validation Info Nodes EXAMPLE <command>certificateget</command> <page>1</page> <domains> <domainname>example.com</domainname> </domains> Page 78

85 certificateparsecsr Use this command to validate a certificate signing request at a Certificate Authority and retrieve the details of the request for a certificate. Required productid Yes Identifier of the certificate. csr Yes The certificate signing request. productid csr/ domainname companyname companyunitname address telephonenumber addressline1 addressline2 city province postalcode countrycode Identifier of the certificate. The domain name, e.g. example.com to which the certificate belongs. The certificate authors company name. The certificate authors division name. address for the certificate owner. Telephone number for the certificate owner. First line of certificate owner address. Second line of certificate owner address. City of certificate owner. Province/County of certificate owner. Postal Code for the certificate owner. 2-char ISO code of Country of contact address (see APPENDIX C Country Codes). Page 79

86 EXAMPLE <command>certificateparsecsr</command> <productid> </productid> <csr> -----BEGIN NEW CERTIFICATE MIIDbTCCAtYCAQAwfjELMAkGA1UEBhMCR0IxEDAOBgNVBAgMB0NhcmRpZmYxEDAO BgNVBAcMB0NhcmRpZmYxFTATBgNVBAoMDFJlZ2lzdGVyLmNvbTEUMBIGA1UECwwL UmNvbm5lY3Rpb24xHjAcBgNVBAMMFXd3dy5wYXVsdGVzdGxvY2FsLmNvbTCBnzAN BgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAtyKSwiuRF3+h338TmCuouzlUFbaLu5Xz UeXLfVRZX6AcmcgxGSY3iZNZXdt5lGTEVpFLnUBAD2940qOMCEmH8WBextYrLuBV 9sVWx94UTB8uZMILZG5A2f7vp0E/dEdRt69u2gRAOM/KkTRUhidYVGYmdC4cEfvJ H22eGUFaG5UCAwEAAaCCAa0wGgYKKwYBBAGCNw0CAzEMFgo2LjEuNzYwMC4yMEkG CSsGAQQBgjcVFDE8MDoCAQUMD3VrUGF1bC5yY29tLmNvbQwXRklDV09SS0dST1VQ XHBncmlmZml0aHMMC0luZXRNZ3IuZXhlMHIGCisGAQQBgjcNAgIxZDBiAgEBHloA TQBpAGMAcgBvAHMAbwBmAHQAIABSAFMAQQAgAFMAQwBoAGEAbgBuAGUAbAAgAEMA cgb5ahaadabvagcacgbhahaaaabpagmaiabqahiabwb2agkazablahidaqawgc8g CSqGSIb3DQEJDjGBwTCBvjAOBgNVHQ8BAf8EBAMCBPAwEwYDVR0lBAwwCgYIKwYB BQUHAwEweAYJKoZIhvcNAQkPBGswaTAOBggqhkiG9w0DAgICAIAwDgYIKoZIhvcN AwQCAgCAMAsGCWCGSAFlAwQBKjALBglghkgBZQMEAS0wCwYJYIZIAWUDBAECMAsG CWCGSAFlAwQBBTAHBgUrDgMCBzAKBggqhkiG9w0DBzAdBgNVHQ4EFgQUC151Qfou uehvdwgrr35fgkd00yowdqyjkozihvcnaqefbqadgyeahak5ahlomrszpbpckh85 eforwekx4vrqwku58tiwguyatbh9mods85w2wfrggda7nykc4ulyxddq8j4gp6zf BKqsGID6YUdvRdgbY+sm8e/Q3Khl38moeblj95y3wbGtP+jND1+n2vdlRtyxQSYW shcloidnsx4vavlo+ey9dyo= -----END NEW CERTIFICATE </csr> Page 80

87 certificatereconfigure Use this command to re-configure a certificate once the initial configuration has been run. This allows for changing the key properties of the request body prior to the request actually having been processed in the event a mistake has been made, or a change required. Required productid Yes Identifier of the certificate. servertype Yes As per APPENDIX G Web Server Types. certificatevalidationmode No As per APPENDIX V Certificate Validation Mode Types (default ) approver address Yes address of approver. csr Yes Certificate Signing Request (CSR) code. contact/ Yes * (either registration or administration contact) * Supply full contact parameters (as per APPENDIX A Contact Fields). productid certificatevalidationinfo/ certificatevalidationmode certificatevalidation Identifier of the SSL certificate. This node is only visible if the Validation Mode is anything OTHER than (default) APPENDIX V Certificate Validation Mode Types APPENDIX W Certificate Validation Info Nodes Page 81

88 EXAMPLE <command>certificatereconfigure</command> <productid> </productid> <servertype>aol</servertype> <certificatevalidationmode>file</certificatevalidationmode> <csr> -----BEGIN NEW CERTIFICATE MIIDazCCAtQCAQAwfDELMAkGA1UEBhMCR0IxEDAOBgNVBAgMB2NhcmRpZmYxEDAO -----END NEW CERTIFICATE </csr> <contact> <firstname>domain</firstname> <lastname>registrar</lastname> <telephonenumber> </telephonenumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province> </province> <postalcode>10018</postalcode> <countrycode>us</countrycode> <contacttype>administration</contacttype> </contact> Page 82

89 certificateresend Use this command to resend the notifications that are sent in the certificate commands. Required productid Yes Identifier of the certificate. type Yes Type of notification to resend (See APPENDIX R Certificate Types). Response will show the success of the resend via the Status node in the standard API response. EXAMPLE <command>certificateresend </command> <productid> </productid> < type></ type> Page 83

90 mobilehostingadd Purchase a new mobile hosting package, optionally assigned to a pre-defined user account. Required userid term producttype Yes Yes Identifier of the user account. Term of the mobile hosting package subscription, e.g. Month or Year. Type of mobile hosting package. (APPENDIX U Mobile Hosting Product Types) domainname Yes The domain name, e.g. example.com. updatedns mobile/ Yes Update available DNS records, e.g. True or False contact/ Yes * description Yes Description of the business. * Supply full contact parameters (as per APPENDIX A Contact Fields). productid Identifier of the mobile hosting package. Page 84

91 EXAMPLE <command>mobilehostingadd</command> <userid></userid> <term>year</term> <producttype>web-mobile-hosting</producttype> <domainname>example.com</domainname> <updatedns>false</updatedns> <mobile> <contact> <firstname>domain</firstname> <lastname>registrar</lastname> <telephonenumber> </telephonenumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>ny</state> <postalcode>10018</postalcode> <countrycode>us</countrycode> </contact> <description>business venture...</description> </mobile> Page 85

92 mobilehostingmodify Update any contact information related to the mobile hosting package. Required productid Identifier of the mobile hosting package. mobile/ contact/ Yes * businessdescription Yes Description of the business. * Supply full contact parameters (as per APPENDIX A Contact Fields). productid Identifier of the mobile hosting package. EXAMPLE <command>mobilehostingmodify</command> <productid> </productid> <mobile> <contact> <firstname>domain</firstname> <lastname>registrar</lastname> < address>[email protected]</ address> <telephonenumber> </telephonenumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>ny</state> <postalcode>10018</postalcode> <countrycode>us</countrycode> </contact> <businessdescription>business venture...</businessdescription> </mobile> Page 86

93 mobilehostingautorenew Use this command to change the status of auto renew for a mobile-hosting package. Required productid Yes Identifier of the mobile-hosting package. autorenew Yes Status of auto renew, e.g. TRUE or FALSE. productid Identifier of the mobile-hosting package. EXAMPLE <command>mobilehostingautorenew</command> <productid> </productid> <autorenew>true</autorenew> Page 87

94 mobilehostingcancel Use this command to cancel a mobile-hosting package subscription. Cancellation of a mobile-hosting package changes the status from Active to Cancelled. Once an Active package is cancelled it continues to be available until the current subscription period lapses. Required productid Yes Identifier of the mobile-hosting package. productid Identifier of the mobile-hosting package. EXAMPLE <command>mobilehostingcancel</command> <productid> </productid> Page 88

95 mobilehostingget Use to query details for: i. One or more specific domains associated with the mobile-hosting packages (include in domains node); or ii. All the mobile-hosting packages associated with a user account (include userid ); or iii. All the mobile-hosting packages associated with a partner (supply page only). Mobile-hosting packages with a status of Deleted are not included in response unless specifically included in the request. 25 mobile-hosting packages are returned per page. Required userid * Identifier of the user account. page * domains/ The page to return (can use if more than 25 mobilehosting packages meet request criteria). The domain name, e.g. example.com associated with domainname * the mobile-hosting package. * At least one of these must be provided: userid, page, or domainname (see above for details). currentpage totalpages recordcount mobilehostingget/ domain/ userid mobilehostinginfo/ domainname productid mobilehostingstatus producttype startdate expirydate autorenew expirydatetime mobile/ (all elements below are repeated for each mobile-hosting package returned) Identifier of associated user. The domain name associate to the mobile-hosting package. Identifier of the mobile-hosting package. Mobile-hosting package status (See APPENDIX O Product Statuses). Type of mobile-hosting package. (See APPENDIX U Mobile Hosting Product Types). The date on which the mobile-hosting package commenced. Expiry date of the mobile-hosting package subscription. Identifies if the auto-renew on expiry is enabled e.g. ON or OFF. Expiry date and time of the mobile-hosting package subscription. Page 89

96 businessdescription contact/ title firstname lastname companyname companypositionheld address telephonenumber faxnumber addressline1 addressline2 city province state postalcode countrycode contacttype Title of contact. First name of the contact. Last name of the contact. Company that the contact belongs to. Position contact holds at their company. address of contact. Telephone number of contact. Fax number of contact. First line of contact s address. Second line of card contact s address. City of contact. Province/County of contact. State of contact. Postal Code for the contact. 2-char ISO code of Country of contact s address (see APPENDIX C Country Codes). Registration or Administration. EXAMPLE <command>mobilehostingget</command> <userid>654321</userid> <page>1</page> <domains> <domainname>example.com</domainname> </domains> Page 90

97 mobilehostinglogin Use this command to return a URL that can be used to single sign on to the mobile hosting management UI. Required productid Yes Identifier of the mobile hosting package. productid singlesignonurl Identifier of the mobile hosting package. URL used to Sign into the mobile hosting account EXAMPLE <command>mobilehostinglogin</command> <clientref>test</clientref> <productid> </productid> EXAMPLE <serviceresponse> <command>mobilehostinglogin</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <response> <productid> </productid> <singlesignonurl> 91f4-9f0c3f561911&utc=8/12/2013 1:41:01 PM&hash=7F284BD7DB70D45F01673CF9FDECBA93 </singlesignonurl> </response> </serviceresponse> Page 91

98 orderhistory Use this command to retrieve the audit information on a single product. 25 audit records are returned per page. Required productid Yes Identifier of the product. page Yes The page to return. history/ action/ actionid actiontype timestamp status description ipaddress (all elements below are repeated for each action returned) Identifier of the audit record. Type of audit record. Time stamp of audit execution. Status of the product at time of audit. Description of the audit record. IP address of the client. EXAMPLE <command>orderhistory</command> <productid> </productid> <page>1</page> Page 92

99 shoppingcartcreate Use this command to instantiate a shopping cart. Required userid No Identifier of the user account. useragentid No Identifier for a user agent. shoppingcartid Identifier of the shopping cart. EXAMPLE <command>shoppingcartcreate</command> <userid></userid> <useragentid></useragentid> Page 93

100 shoppingcartget Use this command to retrieve the cart items of a shopping cart. Required shoppingcartid Yes Identifier of the shopping cart. page Yes The page to return. pagesize Yes The number of rows per page. statuses/ status Yes Yes shoppingcart/ shoppingcartid page shoppingcartproductsubtotal shoppingcarttotalcharges shoppingcartordertotal shoppingcartcurrencycode shoppingcartitem/ shoppingcartitemid producttype term status domainname description itemproductsubtotal itemtotalcharges itemordertotal itemcurrencycode Identifier of the shopping cart. Page number Sum of all the product costs in shopping cart. Sum of all the product charges in the shopping card. e.g. Credit Card Charge etc Sum of shoppingcartproductsubtotal and shoppingcarttotalcharges Currency code for shopping cart totals and charges (all elements below are repeated for each item returned) Identifier of the shopping cart item. Name of the product. Term of the subscription, e.g. Month or Year. The status of the shopping cart item e.g. New, Deleted, Success, Failure The domain name to which the product belongs, e.g. example.com. Friendly description of the cart item Product cost Product charge Sum of itemproductsubtotal and itemtotalcharges Currency code for item totals and charges. shoppingcartsubitems/ shoppingcartsubitem/ subitemprice subitemdescription (all elements below are repeated for each sub item returned) Price for the sub item Description for the sub item Page 94

101 subitemordertype subitemsaletype The order type for the sub item. The sale type for the sub item. Page 95

102 EXAMPLE <command>shoppingcartget</command> <shoppingcartid>874e75b0-fa2e-4e46-a737-9ba06ec4c95f</shoppingcartid> <page> 1</ page > <pagesize>10</pagesize> <statuses> <statuses>new</statuses> </statuses> Page 96

103 shoppingcartitemdelete Use this command to remove a cart item from the shopping cart. Required shoppingcartid Yes Identifier of the shopping cart. shoppingcartitemid Yes Identifier of the cart item. The API standard response showing the Status of the removal but no other detail will be returned in the response. EXAMPLE <command>shoppingcartitemdelete</command> <shoppingcartid>874e75b0-fa2e-4e46-a737-9ba06ec4c95f</shoppingcartid> <shoppingcartitemid>b9eac872-a03a-4424-aae8-7eab </shoppingcartitemid> Page 97

104 shoppingcartcheckout Use this command to process the cart items. Required shoppingcartid Yes Identifier of the shopping cart. userid Yes Identifier of the user account. paymentcardonfilereference Identifier of the card of file. NB: If the reseller s customer type is Internal this value must be supplied. paymentid Payment transaction identifier. NB: This paymentid is only returned when a paymentcardonfilereference is supplied EXAMPLE <command>shoppingcartcheckout</command> <paymentid>874e75b0-fa2e-4e46-a737-9ba06ec4c95f</paymentid> Page 98

105 paymentcardonfilecreate Use this command to create a payment card on file for a user account. Required userid amount currenycode paymentcardinformation/ cardholderdetails/ Identifier of the user account. An authorisation amount Currency of the authorisation amount firstname Yes First name of the card owner lastname Yes Last name of the card owner addressline1 Yes First line of card owner s address addressline2 Second line of card owner s address city Yes City of card owner province state Province/County of card owner State of card owner postalcode Yes Postal Code for the card owner countrycode carddetails/ Yes 2-char ISO code of Country of card owner s address (see APPENDIX C Country Codes) cardtype Yes Card type e.g. VISA. (see APPENDIX K Card Types) cardnumber Yes Card identifying number. expirydate/ startdate/ month Yes Month of the card s expiry. year Yes Year of the card s expiry. month year Only required with Maestro Cards Month of the card s start date. Year of the card s start date. cvc Yes Card verification code. issuenumber Card issue number. NB: Only required with Maestro Cards paymentcardonfilereference Identifier of the card of file. Page 99

106 EXAMPLE <command>paymentcardonfilecreate</command> <applicationguid> </applicationguid> <clientref> </clientref> <userid></userid> <amount></amount> <currencycode></currencycode> <paymentcardinformation> <cardholderdetails> <firstname>domain</firstname> <lastname>registrar</lastname> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>ny</state> <postalcode>10018</postalcode> <countrycode>us</countrycode> </cardholderdetails> <carddetails> <cardtype></cardtype> <cardnumber></cardnumber> <expirydate> <month></month> <year></year> </expirydate> <startdate> <month></month> <year></year> </startdate> <cvc></cvc> <issuenumber></issuenumber> </carddetails> </paymentcardinformation> Page 100

107 paymentcardonfileget Use this command to retrieve a list of cards on file for a user account. Required userid status Identifier of the user account. The card on file status e.g. Active, Failed, Cancelled page Yes The page to return. paymentcardonfilereference firstname lastname addressline1 addressline2 city province state postalcode countrycode cardnumber cardtype expirydate startdate cvc isdefault description Identifier of the shopping cart. First name of the card owner. Last name of the card owner. First line of card owner s address. Second line of card owner s address. City of card owner. Province/County of card owner State of card owner. Postal Code for the card owner. 2-char ISO code of Country of card owner s address (see APPENDIX C Country Codes) Card identifying number. NB: This is mask so that only the last 4-digits show. Card type e.g. VISA. (see APPENDIX K Card Types) Expiry date of the card. Start date of the card. Card verification code. Indicator of primary card on file e.g. True or False Friendly description of card. Page 101

108 EXAMPLE <command>paymentcardonfileget</command> <userid></userid> <page>1</page> Page 102

109 productconfigurationget Use this command to retrieve a list of products that are configured for a reseller account. No request parameters are required expect for the standard API client details. Attribute productgroups/ productgroup/ productgroupid productgroupdescription (all elements below are repeated for each product group returned) Identifier of the product group record. Description of the product group record. products/ product/ productid productname productdescription productcode (all elements below are repeated for each product found in a product group) Identifier of the product. Represents the product friendly-name i.e. WEB-WINHOSTING-UNLIMITED. Description of the product. SKU identifier for the product. billingperiods/ billingperiod/ prices/ price billingperiodid billingperiodname billingperiodmonths priceamount currencycode saletypeid saletypedescription Identifier of the available billing period for a product. Represents the billing periods friendly-name i.e. MONTH. Represents the number of months that the billing period represents. The decimal value of the product price. Currency of the priceamount. Identifier of the sale type for the priceamout. Description of the sale type for the priceamount. EXAMPLE <command>productconfigurationget</command> Page 103

110 Page 104

111 ecommerceadd Use this command to purchase an ecommerce package, optionally assigning to a pre-defined user account. Required userid Identifier of the user account. term Yes Number of years for which the ecommerce package is to be billed. producttype Yes Type of ecommerce package (See APPENDIX L ecommerce Products). domainname Yes Domain name for the package. productid password ipaddress Identifier of the ecommerce package. Password associated with the ecommerce package. IP address of the ecommerce package s server. EXAMPLE <command>ecommerceadd</command> <userid>654321</userid> <term>1</term> <producttype>web-ecommerce</producttype> <domainname>example.com</domainname> Page 105

112 ecommerceautorenew Use this command to change the status of auto renew for an ecommerce package. Required productid Yes Identifier of the ecommerce package. autorenew Yes Status of auto renew, e.g. TRUE or FALSE. productid Identifier of the ecommerce package. EXAMPLE <command>ecommerceautorenew</command> <productid> </productid> <autorenew>true</autorenew> Page 106

113 ecommercecancel Use this command to cancel an ecommerce package subscription. Cancellation of an ecommerce package changes the status from Active to Cancelled. Once an Active package is cancelled it continues to be available until the current subscription period lapses. Required productid Yes Identifier of the ecommerce package. productid Identifier of the ecommerce package. EXAMPLE <command>ecommercecancel</command> <productid> </productid> Page 107

114 ecommerceget Use to query details for: i. One or more specific domains associated with the ecommerce packages (include in domains node); or ii. All the ecommerce packages associated with a user account (include userid ); or iii. All the ecommerce packages associated with a partner (supply page only). ECommerce packages with a status of Deleted are not included in response unless specifically included in the request. 25 ecommerce packages are returned per page. Required userid * Identifier of the user account. page * domains/ The page to return (can use if more than 25 ecommerce packages meet request criteria). The domain name, e.g. example.com associated with the domainname * ecommerce package. * At least one of these must be provided: userid, page, or domainname (see above for details). currentpage totalpages recordcount ecommerceget/ domain/ userid ecommerceinfo/ domainname productid ecommercestatus producttype startdate expirydate autorenew expirydatetime (all elements below are repeated for each ecommerce package returned) Identifier of associated user. The domain name associate to the ecommerce package. Identifier of the ecommerce package. ECommerce package status (See APPENDIX O Product Statuses). Type of ecommerce package. (See APPENDIX L ecommerce Products). The date on which the ecommerce package commenced. Subscription expiry date for the ecommerce package. Identifies if the auto-renew on expiry is enabled. e.g. ON or OFF. Subscription expiry date and time for the ecommerce package. Page 108

115 EXAMPLE <command>ecommerceget</command> <page>1</page> <domains> <domainname>example.com</domainname> </domains> Page 109

116 ecommerceproducttype Use this command to change the ecommerce package type. The subscription cost for the associated ecommerce package is updated and applied, starting from the next renewal date. Required productid Yes Identifier of the ecommerce package. producttype Yes Type of ecommerce package (See APPENDIX L ecommerce Products). productid Identifier of the ecommerce package. EXAMPLE <command> ecommerceproducttype</command> <productid> </productid> <producttype>web-ecommerce-premium</producttype> Page 110

117 ecommercelogin Use this command to return a URL that can be used to single sign on to the ecommerce management UI. Required productid Yes Identifier of the ecommerce package. productid singlesignonurl Identifier of the ecommerce package. URL used to Sign into the ecommerce account EXAMPLE <command>ecommercelogin</command> <productid> </productid> EXAMPLE <serviceresponse> <command>ecommercelogin</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <response> <productid> </productid> <singlesignonurl> b329-9f2405f47304&utc=8/12/2013 1:43:53 PM&hash=1B23757E71245B167FEDA938BEDE6BC9 </singlesignonurl> </response> </serviceresponse> Page 111

118 sitebuilderadd Purchase a new site builder package with the option to assign to a pre-defined user account. Required userid Identifier of the user account. term Yes Number of years for which the site builder package is to be billed. producttype Yes Type of site builder package (See APPENDIX M Site Builder Products). domainname Yes Domain name for the package. ftpinfo/ ftplocation Yes FTP server details. ftpdirectory Yes FTP directory name to use at the FTP location. ftpusername Yes FTP user name to access the FTP location and FTP Directory. ftppassword Yes FTP password to access the FTP location and FTP Directory. productid Identifier of the site builder package. EXAMPLE <command>sitebuilderadd</command> <userid></userid> <term>1</term> <producttype>site-builder</producttype> <domainname> example.com</ domainname > <ftpinfo> <ftplocation> </ftplocation> <ftpdirectory>directory</ftpdirectory> <ftpusername>username</ftpusername> <ftppassword>password</ftppassword> </ftpinfo> Page 112

119 sitebuilderautorenew Use this command to change the status of auto renew for a site builder package. Required productid Yes Identifier of the site builder package. autorenew Yes Status of auto renew, e.g. TRUE or FALSE. productid Identifier of the site builder package. EXAMPLE <command>sitebuilderautorenew</command> <productid> </productid> <autorenew>true</autorenew> Page 113

120 sitebuildercancel Use this command to cancel a site builder package subscription. Cancellation of a site builder package changes the status from Active to Cancelled. Once an Active package is cancelled it continues to be available until the current subscription period lapses. Required productid Yes Identifier of the site builder package. productid Identifier of the site builder package. EXAMPLE <command>sitebuildercancel</command> <productid> </productid> Page 114

121 sitebuilderget Use to query details for: i. One or more specific domains associated with the site builder packages (include in domains node); or ii. All the site builder packages associated with a user account (include userid); or iii. All the site builder packages associated with a partner (supply page only). Site Builder packages with a status of Deleted are not included in response unless specifically included in the request. 25 site builder packages are returned per page. Required userid * Identifier of the user account. page * domains/ The page to return (can use if more than 25 site builder packages meet request criteria). The domain name, e.g. example.com associated with the site builder domainname * package. * At least one of these must be provided: userid, page, or domainname (see above for details). currentpage totalpages recordcount sitebuilderget/ domain/ userid sitebuilderinfo/ domainname productid sitebuilderstatus producttype startdate expirydate autorenew ftpusername ftppassword ftpdirectory ftplocation (all elements below are repeated for each site builder package returned) Identifier of associated user. The domain name associate to the site builder package. Identifier of the site builder package. Site builder package status (See APPENDIX O Product Statuses). Type of site builder package (See APPENDIX M Site Builder Products). The date on which the site builder package commenced. Expiry date of the site builder package subscription. Shows as to whether the site builder package will auto-renew on expiry ON or OFF. FTP user name to access the FTP location and FTP Directory. FTP password to access the FTP location and FTP Directory. FTP directory name at the FTP location. FTP server details. Page 115

122 EXAMPLE <command>sitebuilderget</command> <page>1</page> <domains> <domainname>example.com</domainname> </domains> Page 116

123 sitebuildermodify Use this command to modify the ftp details of the site builder package. Required productid Yes Identifier of the site builder package. ftplocation Yes FTP server details. ftpdirectory Yes FTP directory name at the FTP location. ftpusername Yes FTP user name to access the FTP location. ftppassword Yes FTP password to access the FTP location. productid Identifier of the site builder package. EXAMPLE <command> sitebuildermodify</command> <productid> </productid> <ftpinfo> <ftplocation> </ftplocation> <ftpdirectory>directory</ftpdirectory> <ftpusername>username</ftpusername> <ftppassword>password</ftppassword> </ftpinfo> Page 117

124 mailpassword Use this command to reset the password for a mail package. Required productid Yes Identifier of the mail package. password Yes New password for the mail package. productid password Identifier of the mail package. The new password for the mail package. EXAMPLE <command>mailpassword</command> <productid> </productid> <password>password</password> Page 118

125 reportget Use this command to retrieve a list of domains based on report type. Required reporttype Yes Report type identifier (See APPENDIX Q Report Types). startdate Yes Report data start date in the format YYYYMMDD. enddate Yes Report data end date in the format YYYYMMDD. page The page to return (can use if more than 25 domains in the request criteria). ArrayOfReport[reportType]/ Report[reportType]DataItem / [Data] This will be repeated based on the number of domains returned for the report. Data types differ per report type (See definitions below). REGISTRATION DATA DomainName OrderDate OrderID RenewDate WholesaleOrderTotal Domain name. The domain purchase date. The domain order identifier. The domain expiry date. The cost of the domain purchase. RENEWAL DATA DomainName OrderDate OrderID RenewDate WholesaleOrderTotal Domain name. The domain purchase date. The domain order identifier. The domain expiry date. The cost of the domain purchase. Page 119

126 TRANSFER IN DATA DomainName InitiationDate LosingRegistrar OrderID TransferStatus WholesaleOrderTotal Domain name. The date the transfer-in was initiated. The registrar that the domain is coming-from, if known. The domain transfer order identifier. The transfer status of the domain (See APPENDIX N Transfer Statuses). The cost of the domain transfer. TRANSFER OUT DATA DomainName GainingRegistrar TransferOutDate Domain name. The registrar that the domain is transferring-to. The date transfer-out was initiated. ORDER SUMMARY DATA Customer Date DomainName ItemDescription OrderID Quantity Resale Term Type Customer name associated to the product. Date the product was purchased. Domain name that is associated to the product. The description of the order e.g. ProductName / Term (COM / 1-YEAR). Order identifier associated to the product. The quantity of the product. Price of the product. Term of the product. Type of product e.g. DOMAIN, HOSTING etc. EXAMPLE <command>reportget</command> <reporttype>registrations</reporttype> <startdate> </startdate> <enddate> </enddate> <page>1</page> Page 120

127 contactadd Use this command to add a contact to a reseller account. Required Min Max userid No Identifier of the user, if no user is specified, the contact will be associated directly to the reseller. 0 1 contact Yes Container that contains the contact info 1 1 title No Title of the contact 0 1 firstname Yes First name of the contact 1 1 lastname Yes Last name of the contact 1 1 companyname No Company name of the contact 0 1 companypositionheld No Position in the company of the contact 0 1 address Yes address of the contact 1 1 telephonenumber Yes Telephone number of the contact 1 1 faxnumber No Fax number of the contact 0 1 addressline1 Yes First line of the address of the contact 1 1 addressline2 No Second line of the address of the contact 0 1 city Yes City of the contact 1 1 province No Province of the contact 0 1 state No State of the contact 0 1 postalcode Yes Postalcode/ZIP of the contact 1 1 countrycode Yes 2 letter country code of the contact 1 1 contacttype No Contact type of the contact, acceptable types are: Administration, Registration, Technical, Billing 0 1 isdefault Boolean value that indicates if the contact will be the default contact for the specified contact type. This value defaults to false. If default is set to true and there is currently another default contact for this reseller or user with the same contact type, the old value will have default set to false. 0 1 contactid ID of the contact Page 121

128 EXAMPLE <command>contactadd</command> <applicationguid> </applicationguid> <clientref>test</clientref> <userid>someuser</userid> <contact> <firstname>mork</firstname> <lastname>fromorc</lastname> <companyname>melnac</companyname> <companypositionheld>refugee</companypositionheld> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>rr#1</addressline1> <addressline2>rr#2</addressline2> <city>bobs Harbour</city> <province>ab</province> <state></state> <postalcode>d3f 4F5</postalCode> <countrycode>ca</countrycode> <contacttype>registration</contacttype> </contact> <isdefault>false</isdefault> Page 122

129 contactget Use this command to retrieve the contact details. Required Min Max contactid Yes ID of the contact being requested 1 1 contact contactid userid firstname lastname addressline1 addressline2 city postalcode country telephonenumber faxnumber address companyname companypositionheld dateadded status contacttype Container for the contact information ContactID of the contact The user that is associated to this contact The first name of the contact The last name of the contact The first line of the address for the contact The second line of the address for the contact The city of the contact The postalcode/zip of the contact The country of the contact The telephone number of the contact The fax number of the contact The address on file for the contact The company name of the contact The position in the company that the contact holds The date the contact was added to the system The current status of the contact within the system The contact Type of the contact. Current values may include: Administration, Registration, Technical, Billing, Monetization, ResellerWhoisContact EXAMPLE <command>contactget</command> <applicationguid>dferwer-435f </applicationguid> <clientref>testreference</clientref> <contactid> </contactid> Page 123

130 contactmodify Modifies a contact at the registry level. NOTE: Using this command will modify the contact on all domains associated with this contact. Also some requests may fail when updating fields on a contact that is associated to a domain that does not support the update of that field. Required Min Max contactid Yes The identifier of the contact to be modified 1 1 contact / Yes The new contact information, all fields must be populated, any missing fields may be deleted in the new contact 1 1 contactid Identifier of the contacted that was modified EXAMPLE <command>contactmodify</command> <clientref>test</clientref> <contactid> </contactid> <contact> <firstname>test</firstname> <lastname>testlast</lastname> <companyname>test company</companyname> <companypositionheld>tech</companypositionheld> < address>[email protected]</ address> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>214 Airport Road</addressLine1> <addressline2></addressline2> <city>mississauga</city> <province>on</province> <state></state> <postalcode>b0w 3B0</postalCode> <countrycode>ca</countrycode> <contacttype>registration</contacttype> </contact> Page 124

131 sitesecurityadd This command adds a new Site Security Product to the partner or to a user account of the logged in partner. Required Min Max shoppingcartid Identifier of the shopping cart. 0 1 userid Identifier of the user account. 0 1 domainname Yes The domain name the product will be associated to. term Yes Number of years for which the domain is to be registered. Allowed values vary by extension. producttype Yes Type of Site Security product (APPENDIX S Site Security Product Types). domain Yes The domain address the product will be associated with productid Identifier of the product that was added. EXAMPLE <command>sitesecurityadd</command> <term>1</term> <producttype>site-lock-premium</producttype> <domainname>example.com</domainname> <domain >[email protected]</domain > <shoppingcartid>71ef518c-8a8b-4d7e-aa5a-3e832ff31911</shoppingcartid> Page 125

132 sitesecurityautorenew This command turns Auto Renewal on or off for an existing site security product. Required productid Yes Identifier of the site Security product. autorenew Yes Status of auto renew, e.g. TRUE or FALSE. productid Identifier of the site Security product. EXAMPLE <command>sitesecurityautorenew</command> <productid></productid> <autorenew>false</autorenew> Page 126

133 sitesecurityget Use to query details for: i. One or more specific domains (include in domains node); or ii. All the domains associated with a user account (include userid and optionally page); or iii. All the domains associated with a partner (supply page only). Products are returned in alphabetical sort sequence. Products with a status of Deleted are not included in response. Required userid * Identifier of the user account. page * domains/ domainname * The page to return (can use if more than 25 domains meet request criteria). The domain name, e.g. example.com. * At least one of these must be provided: userid, page, or domainname (see above for details). currentpage totalpages recordcount sitesecurityget/ sitesecurity/ userid sitesecurityinfo/ domainname productid sitesecuritystatus producttype startdate expirydate autorenew domain expirydatetime (all elements below are repeated for each domain returned) Identifier of associated user. The domain name, e.g. example.com. Identifier of the domain. Active, Expired, Redemption, Deleted or Not Found. SITE-LOCK-PREMIUM, SITE-LOCK-BASIC, SITE-LOCK-ENTERPRISE The date on which the domain was registered in the system. Expiry date of the domain at the registry. Whether the domain is set to attempt automatic renewal before expiry. associated with the product. Date and time of expiry. Page 127

134 EXAMPLE <command>sitesecurityget</command> <page>1</page> Page 128

135 sitesecuritylogin Use this command to return a URL that can be used to single sign on to the site security management UI. Required productid Yes Identifier of the package. productid singlesignonurl Identifier of the package. URL used to Sign into the hosting account EXAMPLE <command>sitesecuritylogin</command> <productid> </productid> Page 129

136 difmautorenew This command turns Auto Renewal on or off for an existing Do It For Me product. Required productid Yes Identifier of the Do It For Me product. autorenew Yes Status of auto renew, e.g. TRUE or FALSE. productid Identifier of the Do It For Me product. EXAMPLE <command>difmautorenew</command> <productid>123456</productid> <autorenew>false</autorenew> Page 130

137 difmsso This command retrieves a URL for logging into the DIFM management system. Required productid Yes Identifier of the Do It For Me product. productid autologinurl Identifier of the Do It For Me product. URL to that can be used to log into the DIFM management system after being HTML Decoded. EXAMPLE <command>difmsso</command> <productid>123456</productid> EXAMPLE <serviceresponse> <command>difmsso</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <response> <productid> </productid> <autologinurl> b807- a1f09cadab9f&utc=7/4/2013 3:45:02 PM&hash=63611CC8B380C40132ED9B1676BAB1E6&lo gouturl=autoclose</autologinurl> </response> </serviceresponse> Page 131

138 difmget Use to query details for: i. One or more specific domain names related to the product (include in domains node); or ii. All the difm products associated with a user account (include userid and page); or iii. All the difm products associated with a partner (supply page only). Products are returned in alphabetical sort sequence. Products with a status of Deleted are not included in response. Required userid * Identifier of the user account. page * domains/ domainname * The page to return (can use if more than 25 domains meet request criteria). The domain name associated to the product, e.g. example.com. * These are OPTIONAL fields and can be used to narrow the search results to a more defined result set. currentpage totalpages recordcount difmget/ difm/ userid difminfo/ domainname productid difmstatus producttype startdate expirydate autorenew expirydatetime (all elements below are repeated for each domain returned) Identifier of associated user. The domain name associated to the product, e.g. example.com. Identifier of the product. Active, Expired, or Not Found. APPENDIX T DIFM Product Types The date on which the product was registered in the system. Expiry date of the product. Whether the product is set to attempt automatic renewal before expiry. Date and time of expiry. Page 132

139 EXAMPLE <command>difmget</command> <page>1</page> Page 133

140 difmadd This command adds a new DIFM Product to the partner or to a user account of the logged in partner. Required Min Max shoppingcartid No Identifier of the shopping cart, this is only 0 1 needed if you are using the shopping cart. userid No Optional field to specify the user to be 0 1 associated to the service term Yes Number of months for which the service is to be 1 1 setup. producttype Yes APPENDIX T DIFM Product Types 1 1 Contacts/ No Optional field to specify the contacts associated 0 1 to the service, if no contacts are specified the default contacts of the user will be used. Contact No Optional field to associate contact to the service 0 1 productid Identifier of the product that was added. EXAMPLE <command>difmadd</command> <clientref>test</clientref> <term>1</term> <producttype>e-works-doitforme</producttype> <contacts> <contact> <title>mr.</title> <firstname>pavan</firstname> <lastname>kumar</lastname> <companyname>test</companyname> <companypositionheld>tester</companypositionheld> < address>[email protected]</ address> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>rr 55</addressLine1> <addressline2>apt34</addressline2> <city>yarmouth</city> <state>ns</state> <postalcode>91234</postalcode> <countrycode>ca</countrycode> <contacttype>registration</contacttype> </contact> </contacts> Page 134

141 serviceadd This command is used to add services products to your account. Required Min Max producttype Yes The name of the service product to add to the account. 1 1 term Yes Number of years for which the service is to be registered. 1 1 userid No Identifier of the user account. 0 1 shoppingcartid No Identifier of the shopping cart. 0 1 productid Identifier of the service product. EXAMPLE <command>serviceadd</command> <term>1</term> <producttype>buyers-club</producttype> EXAMPLE <serviceresponse> <command>serviceadd</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <response> <productid> </productid> </response> </serviceresponse> Page 135

142 domainapplicationadd Apply for a forthcoming domain extension, optionally assigned to a pre-defined user account. The relevant extraattributes required by the registry for the relevant domain extension must be supplied. Required shoppingcartid userid Identifier of the shopping cart. Identifier of the user account. domainname Yes The domain name, e.g. example.com. contacts/ contact/ Yes * (repeated for registration and/or administration contact) nameservers/ nameserver (repeated for each name server) nstype Yes Primary or Secondary. nsname extraattributes/ extraattribute/ Yes Name server URI, e.g. ns1.mynameserver.com. (optional/mandatory depending on extension, see APPENDIX E Extra Attributes) (repeated for each required attribute) extraattributekey Yes Identifier for extended attribute field. extraattributevalue Yes Value to be assigned to the attribute. trademark Base64 Encoded SMD String. allowpremium True / False. Required to be true to allow provisioning of Premium domains. claimid To be specified if the domain has an applicable claim during landrush or within 90 days of the start of general availability ispreregga Queue the domain submission for when GA opens, avoiding application fee charges. (True / False) * Supply full contact parameters (as per APPENDIX A Contact Fields). productid Identifier of the domain application. Page 136

143 Page 137 EXAMPLE <command>domainapplicationadd</command> <userid></userid> <domainname>example.com</domainname> <contacts> <contact> <title></title> <firstname>domain</firstname> <lastname>registrar</lastname> <companyname></companyname> <companypositionheld></companypositionheld> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>fl</state> <postalcode>32258</postalcode> <countrycode>us</countrycode> <contacttype>registration</contacttype> </contact> <contact> <title></title> <firstname>domain</firstname> <lastname>registrar</lastname> <companyname></companyname> <companypositionheld></companypositionheld> <telephonenumber> </telephonenumber> <faxnumber> </faxnumber> <addressline1>addressone</addressline1> <addressline2>addresstwo</addressline2> <city>city</city> <province></province> <state>fl</state> <postalcode>32258</postalcode> <countrycode>us</countrycode> <contacttype>administration</contacttype> </contact> </contacts>

144 domainapplicationget Use to retrieve a list of products in any of the specified states for a given reseller. userid domainapplicationstatus domains/ Identifier of the user account. The status the product is in. viable options are PreRegistered, Landrush or Sunrise domainname The domain name, e.g. example.com. All of the parameters are optional parameters. If no parameters are provided a list of ALL products in ALL states for ALL users under a given reseller will be returned. domainapplicationget/ domains/ domain/ DomainName ProductPlanID StatusID UserLoginID StartDate EndDate currentpage (all elements below are repeated for each domain returned) The domain name The identifier of the plan PreRegistered, Landrush or Sunrise The identifier of associated user to this plan The date on which the domain was registered in the system. The date on which the plan will end totalpages recordcount EXAMPLE <command>domainapplicationget</command> <clientref> </clientref> <language> </language> <domains /> Page 138

145 productinfoget Use to retrieve a list of products, rules and phases for a given reseller, being able to filter by product family, launch phase and types of products. Required Min Max productfamily productlaunchphase Yes No Product family of the product. Eg: Domains The TLD launch phase of the product. Eg: Phase1, Phase2, Phase3 Page producttypes/ No 0 1 producttype No The product name. Eg: NET, COM 0 - All of the parameters except the product family are optional parameters. If no parameters are provided a list of ALL products in ALL phases and ANY product name under a given reseller will be returned. productgroup/ product/ (all elements below are repeated for each product returned) productid The id of the product. Eg: 12 productname productdescription productcode productcategory productphases/ productphase/ phasetype phasestartdate phaseenddate productrules/ productrule/ productruledescription The name of the product. Eg: NET The description of the product. Eg: Domain.NET Extension The code of the product. Eg: 00000NET The category of the product. Eg: Business (all elements below are repeated for each phase of the product returned) Eg: "Landrush" Eg: " T00:00:00-03:00" Eg: " T00:00:00-03:00" productrulethirdpartyfield Eg: "X-ATT-TYPE " productruleregularexpression Eg: "^0*[1-9]\d*$ " productrulecondition Eg: "All " productruledatatype Eg: "enum " productruledata/ productrulevalue/ productrulevaluedescription (all elements below are repeated for each rule of the product returned) Eg: "Proof of web business company number" (all elements below are repeated for each rule data value for the current rule if any) Eg: Company

146 productrulevalue Eg: COMP EXAMPLE <command>productinfoget</command> <productfamily>domains</productfamily> <productlaunchphase>phase3</productlaunchphase> <producttypes> <producttype>net</producttype> <producttype>com</producttype> </producttypes> Page 140

147 domainapplicationsignmarkparse Use to parse an encoded trademark. This command returns a success response (1000 code) if successfully otherwise has details of the failure. sld e.g. The example in exampledomain.com signmarkdata The base64 encoded trademark data Both of the parameters are mandatory. EXAMPLE <command>domainapplicationsignmarkparse</command> <applicationguid> </applicationguid> <clientref>test</clientref> <sld>marktest5</sld> <signmarkdata>pd94bwwgdmvyc2lvbj0ims4wiiblbmnvzgluzz0ivvrgltgiihn0yw5kywxv bmu9im5vij8+phntzdpzawduzwrnyxjrihhtbg5zonntzd0idxjuomlldgy6cgfyyw1zonhtbdpucz pzawduzwrnyxjrlteumcigawq9innpz25lze1hcmsipgogidxzbwq6awq+mtizpc9zbwq6awq+ciag PHNtZDppc3N1ZXJJbmZvIGlzc3VlcklEPSIzIj4KICAgIDxzbWQ6b3JnPm9yZ2FuaXNhdGlvbjwvc2 1kOm9yZz4KICAgIDxzbWQ6ZW1haWw+c3VwcG9ydEBleGFtcGxlLmNvbTwvc21kOmVtYWlsPgogICAg PHNtZDp1cmw+aHR0cDovL3d3dy5leGFtcGxlLmNvbTwvc21kOnVybD4KICAgIDxzbWQ6dm9pY2UgeD 0iMTIzNCI+KzYxLjExMTExMTExPC9zbWQ6dm9pY2U+CiAgPC9zbWQ6aXNzdWVySW5mbz4KICA8c21k =</signmarkdata> EXAMPLE <serviceresponse> <command>domainapplicationsignmarkparse</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> </serviceresponse> Page 141

148 domainpremiumspin Use to check for suggestions of premium domain names based on the supplied sld. Also to check availability and status sld extensions/ extension All parameters are mandatory The example in e.g. com, net, org etc.. domain/ Containing node of repeating result sets of information domainname Domain in format (exampledomain.com) domainavailable Yes/No response price Value in 2 decimal place format eg EXAMPLE <command>domainpremiumspin</command> <applicationguid> </applicationguid> <clientref/> <sld>example</sld> <extensions> <extension>com</extension> </extensions> Page 142

149 EXAMPLE <serviceresponse> <command>domainpremiumspin</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <response> <domain> <domainname>exampleonline.com</domainname> <domainavailable>yes</domainavailable> <price>688.00</price> </domain> <domain> <domainname>examplesports.com</domainname> <domainavailable>yes</domainavailable> <price> </price> </domain> </response> </serviceresponse> Page 143

150 premiumdomainadd Use to add a Premium Domain product to an accounts portfolio. Required Min Max shoppingcartid No Guid of the Shopping cart 0 1 userid No Identifier of the user account. 0 1 domainname Yes The domain name, e.g. example.com. 1 1 contacts/ No 0 1 contact * APPENDIX A Contact Fields 0 3 nameservers/ No 0 1 nameserver/ ** (repeat for each entry) 2 12 nstype Yes Enumeration (Primary / Secondary) 1 1 nsname Yes String hostname (e.g dns1.register.com) 1 1 nsip No String IPAddress (e.g ) 0 1 * Contact Xml Data should be supplied in the format outlined in the linked Appendix entry ** Nameserver Xml Data is required only if the outer Nameservers node is supplied productid Unique identifier of the provisioned domain EXAMPLE <command>premiumdomainadd</command> <applicationguid> </applicationguid> <clientref>test</clientref> <language>en</language> <domainname>exampleonline.com</domainname> <nameservers> <nameserver> <nstype>primary</nstype> <nsname>dns1.register.com</nsname> </nameserver> <nameserver> <nstype>secondary</nstype> <nsname>dns2.register.com</nsname> </nameserver> </nameservers> Page 144

151 EXAMPLE <serviceresponse> <command>premiumdomainadd</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <response> <productid> </productid> </response> </serviceresponse> Page 145

152 domainclaiminfo Use to query claim information for a domain name via a claim ID. Required Min Max claimid* Yes The ID of the claim for the domain name 1 1 * claimid is returned via domaincheck is a claim exists against a domain name. domainclaiminfo The XML representation of the claim information for the domain name. EXAMPLE <command>domainclaiminfo</command> <applicationguid> </applicationguid> <clientref>test</clientref> <language>en</language> <claimid> /b/a/e/uulvrzts5dwokx5diezxcxc </claimid> EXAMPLE <serviceresponse> <command>domainclaiminfo</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <response> <domainclaiminfo> <tmnotice:notice xmlns:tmnotice="urn:ietf:params:xml:ns:tmnotice-1.0"> <tmnotice:id>2b01901a </tmnotice:id> <tmnotice:notbefore> t00:00:00.0z</tmnotice:notbefore> <tmnotice:notafter> t00:00:00.0z</tmnotice:notafter> <tmnotice:label>claim1</tmnotice:label> <tmnotice:claim> <tmnotice:markname>example One</tmNotice:markName> <tmnotice:holder entitlement="owner"> <tmnotice:org>example Inc.</tmNotice:org> <tmnotice:addr> <tmnotice:street>123 Example Dr.</tmNotice:street> <tmnotice:street>suite 100</tmNotice:street> <tmnotice:city>reston</tmnotice:city> <tmnotice:sp>va</tmnotice:sp> Page 146

153 <tmnotice:pc>20190</tmnotice:pc> <tmnotice:cc>us</tmnotice:cc> </tmnotice:addr> </tmnotice:holder> <tmnotice:contact type="owner"> <tmnotice:name>joe Doe</tmNotice:name> <tmnotice:org>example Inc.</tmNotice:org> <tmnotice:addr> <tmnotice:street>123 Example Dr.</tmNotice:street> <tmnotice:street>suite 100</tmNotice:street> <tmnotice:city>reston</tmnotice:city> <tmnotice:sp>va</tmnotice:sp> <tmnotice:pc>20190</tmnotice:pc> <tmnotice:cc>us</tmnotice:cc> </tmnotice:addr> <tmnotice:voice x="4321"> </tmnotice:voice> </tmnotice:contact> <tmnotice:jurdesc jurcc="us">united STATES OF AMERICA</tmNotice:jurDesc> <tmnotice:classdesc classnum="35"> Advertising; business management; business administration. </tmnotice:classdesc> <tmnotice:classdesc classnum="36"> Insurance; financial affairs; monetary affairs; real estate. </tmnotice:classdesc> <tmnotice:goodsandservices> Bardus populorum circumdabit se cum captiosus populum. Smert populorum circumdabit se cum captiosus populum qui eis differimus. </tmnotice:goodsandservices> </tmnotice:claim> <tmnotice:claim> <tmnotice:markname>example-one</tmnotice:markname> <tmnotice:holder entitlement="owner"> <tmnotice:org>example S.A. de C.V.</tmNotice:org> <tmnotice:addr> <tmnotice:street>calle conocida #343</tmNotice:street> <tmnotice:city>conocida</tmnotice:city> <tmnotice:sp>sp</tmnotice:sp> <tmnotice:pc>82140</tmnotice:pc> <tmnotice:cc>br</tmnotice:cc> </tmnotice:addr> </tmnotice:holder> <tmnotice:jurdesc jurcc="br">brazil</tmnotice:jurdesc> <tmnotice:goodsandservices> Bardus populorum circumdabit se cum captiosus populum. Smert populorum circumdabit se cum captiosus populum qui eis differimus. </tmnotice:goodsandservices> </tmnotice:claim> <tmnotice:claim> <tmnotice:markname>one</tmnotice:markname> <tmnotice:holder entitlement="owner"> <tmnotice:org>one Corporation</tmNotice:org> <tmnotice:addr> <tmnotice:street>otra calle</tmnotice:street> <tmnotice:city>otra ciudad</tmnotice:city> <tmnotice:sp>ot</tmnotice:sp> <tmnotice:pc>383742</tmnotice:pc> <tmnotice:cc>cr</tmnotice:cc> </tmnotice:addr> </tmnotice:holder> <tmnotice:jurdesc jurcc="cr">costa RICA</tmNotice:jurDesc> <tmnotice:goodsandservices> Bardus populorum circumdabit se cum captiosus populum. Smert populorum circumdabit se cum captiosus populum qui eis differimus. </tmnotice:goodsandservices> <tmnotice:notexactmatch> Page 147

154 <tmnotice:court> <tmnotice:refnum>234235</tmnotice:refnum> <tmnotice:cc>cr</tmnotice:cc> <tmnotice:courtname>supreme Court of Justice of Costa Rica</tmNotice:courtName> </tmnotice:court> </tmnotice:notexactmatch> </tmnotice:claim> <tmnotice:claim> <tmnotice:markname>one Inc</tmNotice:markName> <tmnotice:holder entitlement="owner"> <tmnotice:org>one SA de CV</tmNotice:org> <tmnotice:addr> <tmnotice:street>la calle</tmnotice:street> <tmnotice:city>la ciudad</tmnotice:city> <tmnotice:sp>cd</tmnotice:sp> <tmnotice:pc>34323</tmnotice:pc> <tmnotice:cc>ar</tmnotice:cc> </tmnotice:addr> </tmnotice:holder> <tmnotice:jurdesc jurcc="ar">argentina</tmnotice:jurdesc> <tmnotice:goodsandservices> Bardus populorum circumdabit se cum captiosus populum. Smert populorum circumdabit se cum captiosus populum qui eis differimus. </tmnotice:goodsandservices> <tmnotice:notexactmatch> <tmnotice:udrp> <tmnotice:caseno>d </tmnotice:caseno> <tmnotice:udrpprovider>wipo</tmnotice:udrpprovider> </tmnotice:udrp> </tmnotice:notexactmatch> </tmnotice:claim> </tmnotice:notice> </domainclaiminfo> </response> </serviceresponse> Page 148

155 orderget Use to collect order information from a supplied plan identifier. Required Min Max productid Yes The ID of the plan 1 1 order/ orderitems/ orderitem/ orderitemprice orderitemdescription orderitemordertype orderitemsaletype Item Price Item Description Order Type Order Sale Type EXAMPLE <command>orderget</command> <clientref>test</clientref> <language></language> <productid> </productid> Page 149

156 EXAMPLE <command>orderget</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <response> <order> <orderitems> <orderitem> <orderitemprice>25.00</orderitemprice> <orderitemdescription>web / 1 year</orderitemdescription> <orderitemordertype>product</orderitemordertype> <orderitemsaletype>sunrise_app</orderitemsaletype> </orderitem> <orderitem> <orderitemprice>25.00</orderitemprice> <orderitemdescription>web / 1 year</orderitemdescription> <orderitemordertype>product</orderitemordertype> <orderitemsaletype>sunrise_reg</orderitemsaletype> </orderitem> <orderitem> <orderitemprice>-5.00</orderitemprice> <orderitemdescription>10% Buyer's Club discount</orderitemdescription> <orderitemordertype>discount</orderitemordertype> <orderitemsaletype>ini</orderitemsaletype> </orderitem> </orderitems> </order> </response> Page 150

157 poll Use to poll for the next message in the queue. The response will show the (FIFO) message at the top of the queue which needs to be acknowledged before the next message will be visible. The response will give details of the message id, total message count and assorted details regarding the state of the command that is either due to be processed or has already been processed. To move to the next message in the queue, use of the pollack command is required. Required Min Max msgq/ msgq/ [count] msgq/ [id] qdate msg respdata/ Jobid originalcode originalmsg domain/ id command name expdate (this and subsequent nodes present if there are messages on the queue) Attribute : count. Total count of messages in the queue. Attribute : id. ID of first message in the queue. (required for pollack) The timestamp the message was put onto the queue. The description of the message status. Client Reference of Async Message Status code of Async Message Status description of Async Message Product Plan ID The API Command Run Domain Name Expiration Date (currently on domainadd commands only) Page 151

158 EXAMPLE <command>poll</command> <clientref>test</clientref> EXAMPLE <serviceresponse> <command>poll</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <msgq count="2" id="62"> <qdate>11/06/ :59:20</qDate> <msg>success</msg> </msgq> <respdata> <jobid/> <originalcode>1000</originalcode> <originalmsg>success</originalmsg> <domain> <id> </id> <command>domaindelete</command> <name>testdomain.co.uk</name> </domain> </respdata> <statistics> <server /> <execution> <timespan>00:00:04.610</timespan> <startdatetime>07/04/ :00:07</startDateTime> <enddatetime>07/04/ :00:11</endDateTime> </execution> </statistics> </serviceresponse> Page 152

159 pollack Use to acknowledge the specified message and remove it from the top of the queue of messages received by running the previously documented poll command. Once a specific message has been acknowledged, it will be removed from the top of the queue of messages. Note that in the success case, the reponse body of the pollack command will automatically include a poll message response for the next message in the queue. Required Min Max messageid y Integer value of the message to ack 1 1 msgq/ msgq/ [count] msgq/ [id] qdate msg respdata/ Jobid originalcode originalmsg domain/ id command name expdate Attribute : count. Total count of messages in the queue. Attribute : id. ID of first message in the queue. (required for pollack) The timestamp the message was put onto the queue. The description of the message status. Client Reference of Async Message Status code of Async Message Status description of Async Message Product Plan ID The API Command Run Domain Name Expiration Date (currently on domainadd commands only) Page 153

160 EXAMPLE <command>poll</command> <clientref>test</clientref> <messageid>62</messageid> EXAMPLE <serviceresponse> <command>pollack</command> <clientref>test</clientref> <status> <statuscode>1000</statuscode> <statusdescription>success</statusdescription> </status> <msgq count="1" id="63"> <qdate>11/06/ :59:20</qDate> <msg>success</msg> </msgq> <respdata> <jobid/> <originalcode>1000</originalcode> <originalmsg>success</originalmsg> <domain> <id> </id> <command>domaindelete</command> <name>testdomain2.co.uk</name> </domain> </respdata> <statistics> <server /> <execution> <timespan>00:00:04.610</timespan> <startdatetime>07/04/ :00:07</startDateTime> <enddatetime>07/04/ :00:11</endDateTime> </execution> </statistics> </serviceresponse> Page 154

161 Appendices APPENDIX A Contact Fields Required Min Max contact/ title Salutation for contact 20 firstname Yes First Name for contact 50 lastname Yes Last Name for contact 2 50 companyname Name of company represented companypositionheld Name of contact s position in the represented company address Yes address for contact 200 telephonenumber fax Number Yes Telephone number of contact. Must conform to the E.164 format: +[country_code].[number] e.g FAX number for contact. Format as per telephonenumber. addressline1 Yes First line of contact address 4 50 addressline2 Second line of contact address 50 city Yes City of contact address 2 50 province state US only Province/County of contact address (non- US address) 2-char ISO code of State for contact address (US addresses only) (see APPENDIX B US State Codes) postalcode Yes Postal Code for contact address 20 countrycode contacttype Yes Yes 2-char ISO code of Country of contact address (see APPENDIX C Country Codes) Registration, Administration or Technical 2 2 Page 155

162 APPENDIX B US State Codes Code State MO Missouri AE Armed Forces MP Northern Mariana Islands AL Alabama MT Montana AK Alaska NE Nebraska AZ Arizona NV Nevada AR Arkansas NH New Hampshire CA California NJ New Jersey CO Colorado NM New Mexico CT Connecticut NY New York DE Delaware NC North Carolina DC D.C. ND North Dakota FL Florida OH Ohio GA Georgia OK Oklahoma GM Guam OR Oregon HI Hawaii PA Pennsylvania ID Idaho PR Puerto Rico IL Illinois RI Rhode Island IN Indiana SC South Carolina IA Iowa SD South Dakota KS Kansas TN Tennessee KY Kentucky TX Texas LA Louisiana UT Utah ME Maine VT Vermont MD Maryland VA Virginia MA Massachusetts WA Washington MI Michigan WV West Virginia MN Minnesota WI Wisconsin MS Mississippi WY Wyoming Page 156

163 APPENDIX C Country Codes [Based on ISO ] Code Country EU Member AF Afghanistan AL Albania DZ Algeria AS American Samoa AD Andorra AO Angola AI Anguilla AG Antigua And Barbuda AR Argentina AM Armenia AW Aruba AU Australia AT Austria Yes AZ Azerbaijan BS Bahamas BH Bahrain BD Bangladesh BB Barbados BY Belarus BE Belgium Yes BZ Belize BJ Benin BM Bermuda BT Bhutan BO Bolivia BA Bosnia And Herzegovina BW Botswana BR Brazil IO British Indian Ocean Territory BN Brunei Darussalam BG Bulgaria Yes BF Burkina Faso BI Burundi KH Cambodia CM Cameroon CA Canada CV Cape Verde KY Cayman Islands CF Central African Republic Page 157

164 TD Chad CL Chile CN China CX Christmas Island CC Cocos (Keeling) Islands CO Colombia KM Comoros CG Congo, Republic Of CD Congo, The Democratic Republic Of The CK Cook Islands CR Costa Rica CI Côte D'Ivoire HR Croatia CU Cuba CY Cyprus Yes CZ Czech Republic Yes DK Denmark Yes DJ Djibouti DM Dominica DO Dominican Republic EC Ecuador EG Egypt SV El Salvador GQ Equatorial Guinea ER Eritrea EE Estonia Yes ET Ethiopia FO Faeroe Islands FK Falkland Islands FJ Fiji FI Finland Yes FR France Yes GF French Guiana PF French Polynesia GA Gabon GM Gambia GE Georgia DE Germany Yes GH Ghana GI Gibraltar GB Great Britain GR Greece Yes GL Greenland Page 158

165 GD Grenada GP Guadeloupe GU Guam GT Guatemala GG Guernsey GN Guinea GW Guinea-Bissau GY Guyana HT Haiti HN Honduras HK Hong Kong HU Hungary Yes IS Iceland IN India ID Indonesia IR Iran IQ Iraq IE Ireland Yes IM Isle Of Man IL Israel IT Italy Yes JM Jamaica JP Japan JE Jersey JO Jordan KZ Kazakhstan KE Kenya KI Kiribati KP Korea (North) KR Korea (South) KW Kuwait KG Kyrgyzstan LA Lao People's Democratic Republic LV Latvia Yes LB Lebanon LS Lesotho LR Liberia LY Libya LI Liechtenstein LT Lithuania Yes LU Luxembourg Yes MO Macao MK Macedonia Page 159

166 MG Madagascar MW Malawi MY Malaysia MV Maldives ML Mali MT Malta Yes MH Marshall Islands MQ Martinique MR Mauritania MU Mauritius YT Mayotte MX Mexico FM Micronesia MD Moldova MC Monaco MN Mongolia ME Montenegro MS Montserrat MA Morocco MZ Mozambique MM Myanmar NA Namibia NR Nauru NP Nepal NL Netherlands Yes AN Netherlands Antilles NC New Caledonia NZ New Zealand NI Nicaragua NE Niger NG Nigeria NU Niue NF Norfolk Island MP Northern Mariana Islands NO Norway OM Oman PK Pakistan PW Palau PS Palestinian Territories PA Panama PG Papua New Guinea PY Paraguay PE Peru Page 160

167 PH Philippines PL Poland Yes PT Portugal Yes PR Puerto Rico QA Qatar RE Réunion RO Romania Yes RU Russian Federation RW Rwanda SH Saint Helena KN Saint Kitts And Nevis LC Saint Lucia MF Saint Martin PM Saint Pierre And Miquelon VC Saint Vincent And The Grenadines WS Samoa SM San Marino ST Sao Tome And Principe SA Saudi Arabia SN Senegal RS Serbia SC Seychelles SL Sierra Leone SG Singapore SK Slovakia Yes SI Slovenia Yes SB Solomon Islands SO Somalia ZA South Africa ES Spain Yes LK Sri Lanka SD Sudan SR Suriname SZ Swaziland SE Sweden Yes CH Switzerland SY Syria TW Taiwan TJ Tajikistan TZ Tanzania TH Thailand TL Timor-Leste TG Togo Page 161

168 TK Tokelau TO Tonga TT Trinidad And Tobago TN Tunisia TR Turkey TM Turkmenistan TV Tuvalu UG Uganda UA Ukraine AE United Arab Emirates UK United Kingdom Yes US United States UY Uruguay UZ Uzbekistan VU Vanuatu VA Vatican City VE Venezuela VN Viet Nam VG Virgin Islands, British VI Virgin Islands, U.S. WF Wallis And Futuna EH Western Sahara YE Yemen ZM Zambia ZW Zimbabwe Page 162

169 APPENDIX D Supported Extensions SLD TLD Generic TLD com net org biz info aero asia cat coop jobs mobi museum pro aca pro bar pro cpa pro eng pro jur pro law pro med pro tel travel Ascension Islands ac Afghanistan af Antigua and Barbuda ag co ag com ag net ag nom ag org ag Anguilla com ai net ai off ai org ai Armenia am Argentina com ar American Samoa as Austria at co at Page 163

170 or at Australia com au net au Belgium be Bulgaria bg Burundi bi Bolivia bo com bo Brasil com br The Bahamas bs Belarus by Belize bz Canada ca Cocos Islands cc The Democratic Republic of Congo cd Republic of Congo cg Switzerland ch Chile cl Cameroon cm co cm com cm net cm China cn com cn net cn org cn Colombia com co Costa Rica cr co cr Cuba cu com cu Christmas Island cx Czech Republic cz Germany de Djubouti dj Denmark dk Dominica dm Dominican Republic com do net do org do Ecuador ec com ec info ec Page 164

171 Estonia ee Spain es com es nom es org es European Union eu Finland fi Fiji biz fj com fj info fj name fj net fj org fj pro fj Federal State of Micronesia fm France fr asso fr com fr nom fr prd fr presse fr tm fr Grenada gd Guernsey gg co gg net gg org gg Gibraltar gi com gi ltd gi org gi Greenland gl Greece gr com gr South Georgia and the South Sandwich Islands gs Guatemala com gt Guyana gy Hong Kong hk com hk net hk org hk Heard and McDonald Island hm Honduras hn Page 165

172 com hn net hn org hn Haiti ht Hungary hu co hu Indonesia co id or id web id Ireland ie Israel co il org il Isle of Man im co im com im net im org im India in co in firm in gen in ind in net in org in British Indian Ocean Territory io Iran ir Iceland is Italy it Jersey je co je net je org je Japan jp co jp Kyrgyzstan kg com kg net kg org kg Kiribati ki com ki net ki org ki South Korea kr Page 166

173 co kr or kr Kazakhstan kz Lao People's Democratic Republic la Saint Lucia lc co lc com lc net lc org lc Liechtenstein li Lithuania lt Luxembourg lu Latvia lv com lv net lv Libya ly Monaco mc Moldova md Montenegro me Mongolia mn Montserrat ms com ms net ms org ms Malta com mt net mt org mt Mauritius mu ac mu co mu com mu net mu or mu org mu Malawi mw Mexico com mx org mx Malaysia Norfolk Island Page 167 my com my net my org my nf com nf

174 net nf Netherlands nl Norway no Niue nu New Zealand ac nz co nz geek nz gen nz net nz org nz school nz Panama com pa Peru pe com pe Philippines ph com ph net ph org ph Pakistan pk com pk Poland pl biz pl com pl info pl net pl org pl Puerto Rico pr at pr biz pr ch pr com pr de pr eu pr fr pr info pr it pr name pr net pr nl pr org pr pro pr uk pr Occupied Palestinian Territory ps Page 168

175 com ps net ps org ps Portugal pt com pt org pt Paraguay com py Reunion re Romania ro com ro nom ro www ro Russia ru Rwanda rw Saudi Arabia com sa net sa org sa pub sa Solomon Islands com sb net sb org sb Seychelles sc com sc net sc org sc Sweden se Singapore sg com sg Saint Helena sh Slovenia si Slovak Republic sk Sierra Leone sl Sao Tome and Principe st Russia su El Salvador com sv Turks and Caicos Islands tc Thailand co th in th Tokelau tk East Timor tl Turkmenistan tm Tonga to Turkey bbs tr Page 169

176 biz tr com tr gen tr info tr name tr tel tr web tr Trinidad and Tobago tt co tt com tt net tt org tt Tuvalu tv Taiwan tw com tw net tw org tw Ukraine ua com ua Uganda ug United Kingdom co uk ltd uk me uk net uk org uk plc uk United States of America us Uruguay com uy St. Vincent and the Grenadines vc com vc net vc org vc Venezuela com ve British Virgin Islands vg Virgin Islands co vi Vietnam vn com vn int vn net vn org vn Vanuatu vu Western Samoa ws South Africa co za Page 170

177 APPENDIX E Extra Attributes TLD extraattributekey.ro VATNUMBER Tax number (individual) or VAT number (company) required.us IDNUMBER USAPPPURPOSE Personal identification number / Passport number Please supply the relevant code as follows: P1 Business use for profit P2 Non-profit business, club, association, religious organization P3 Personal use P4 Educational purpose P5 Government purpose USNEXUSCATEGORY Please supply the relevant code as follows: C11 A natural person who is a US citizen C12 A natural person who is a permanent resident C21 An entity or organization that is (i) incorporated within one of the fifty US states, the District of Columbia, or any of the US possessions or territories, or (ii) organized or otherwise constituted under the laws of a state of the US, the District of Columbia or any of its possessions and territories (including federal, state, or local government of the US, or a political subdivision thereof, and non-commercial organizations based in the US. C31 A foreign organization that regularly engages in lawful activities (sales of goods or services or other business, commercial, or non-commercial, including not for profit relations) in the United States. The CC equals to the two-letter country code of the organization. C32 An organization has an office or other facility in the U.S., where CC equals to the two-letter country code of the organization..ie.ca COMPANYNUMBER CaLegalType Please provide one of the following for business domains: Company Number Trademark Number RBN Number (Registered Business Number) Please supply the relevant code as follows: ABO Aboriginal Peoples indigenous to Canada ASS Canadian Unincorporated Association CCO Corporation (Canada or Canadian province or territory) CCT Canadian citizen EDU Canadian Educational Institution GOV Government or government entity in Canada HOP Canadian Hospital INB Indian Band recognized by the Indian Act of Canada LAM Canadian Library, Archive or Museum LGR Legal Rep. of a Canadian Citizen or Permanent Resident MAJ Her Majesty the Queen OMK Official mark registered in Canada PLT Canadian Political Party PRT Partnership Registered in Canada RES Permanent Resident of Canada TDM Trade-mark registered in Canada (by a non-canadian owner) TRD Canadian Trade Union TRS Trust established in Canada Page 171

178 TLD extraattributekey.com.au.net.au au-domain-idnumber au-domain-idtype au-domain-relation au-domain-relationtype au-owner-organization Specify the identification number as appropriate. Please supply of the following values ABN Australian Business Number ACN Australian Company Number OTHER This indicates the relationship between the eligibility type and domain name 1 Domain name is an exact match, acronym or abbreviation of the registrants company or trading name, organisation, association or trademark. 2 Domain name is closely and substantially connected to the registrant. Specify what makes the registrant eligible to register the cctld domain name. Company - Company RegisteredBusiness - Registered Business SoleTrader - Sole Trader Partnership - Partnership TrademarkOwner - Trademark Owner PendingTMOwner - Pending TM Owner CitizenResident - Citizen / Resident IncorporatedAssociation - Incorporated Association Club - Club NonProfitOrganisation - Non-profit Organisation Charity - Charity TradeUnion - Trade Union IndustryBody - Industry Body CommercialStatutoryBody - Commercial Statutory Body PoliticalParty - Political Party Other - Other The name of the registrants organisation.org.au au-domain-idnumber Specify the identification number as appropriate. au-domain-idtype au-domain-relation au-domain-relationtype au-owner-organization Please supply of the following values ABN Australian Business Number ACN Australian Company Number OTHER - Specify OTHER for Incorporated Association This indicates the relationship between the eligibility type and domain name 1 Domain name is an exact match, acronym or abbreviation of the registrants company or trading name, organisation, association or trademark. 2 Domain name is closely and substantially connected to the registrant. Specify what makes the registrant eligible to register the cctld domain name. NonProfitOrganisation - Non-profit Organisation Charity - Charity The name of the registrants organisation Page 172

179 APPENDIX F Error Codes Error Code Error Description 1001 Mandatory field missing 1003 Insufficient Funds 1005 User ID already exists 1011 User ID failed validation 1013 User Account Name failed validation 1015 Title failed validation 1017 First Name failed validation 1019 Last Name failed validation 1021 Company Name failed validation 1023 Company Position Held failed validation Address failed validation 1027 Telephone Number failed validation 1029 Fax Number failed validation 1031 Address Line 1 failed validation 1033 Address Line 2 failed validation 1035 City failed validation 1037 County/Province failed validation 1039 Invalid US State 1041 Postal Code failed validation 1043 Invalid Country Code 1055 User Create failed 1065 sld unknown 1101 User ID not known 1103 Product not associated to Reseller 1109 Product ID not known 1114 Domain Delete failed 1115 Domain Add failed 1116 Domain Get failed 1117 Domain Check failed 1123 Domain Modify failed 1124 Domain Transfer failed 1125 Zone Add failed 1126 Domain Transfer Cancel failed 1127 Zone Delete failed 1128 Domain Whois failed 1129 Zone record match not found 1131 Zone Get failed 1163 Domain Spin failed Page 173

180 1165 Update User failed 1167 TLD validation failed 1169 Domain Name unknown 1175 Product not active 1181 Product Gateway unknown 1185 nstype failed validation 1186 Primary Nameserver missing 1187 nsname failed validation 1188 At least one Secondary Nameserver required 1189 nsipaddress failed validation 1191 zonetype failed validation 1193 zonekey failed validation 1195 zonevalue failed validation 1196 zonepriority failed validation 1197 extraattributevalue invalid 1198 extraattributekey unknown 1199 extraattribute missing 1201 Product not found 1202 Term invalid for product 1203 Maximum term exceeded 1204 Product not open for renewal 1207 Domain name could not be found 1209 Page value failed validation Page 174

181 APPENDIX G Web Server Types Type AOL Apache_ModSSL Apache_SSL C2Net_Stronghold Cobalt_Raq Covalent_Server IBM_HTTP IBM_ICS iplanet JavaWebServer Lotus_Domino Lotus_Domain_Go IIS_1x_4x IIS_5x_above NetscapeEnterpriseServer NetscapeFastTrack NovellWebServer Oracle QuidProQuo R3_SSL Raven_SSL RedHat_Linux SAP_WAS Tomcat Website_Pro WebStar_4x_above WebTen ZeusWebServer Ensim Plesk WHM_cPanel H_Sphere31 Other APPENDIX H Certificate Products Type CO-CERTDV CO-CERTDV-W CO-CERTOV CO-CERTOV-W CO-CERT-EV Description Comodo Domain Validation Certificate Comodo Domain Validation Certificate - Wildcard Organization Validation Certificate Comodo Organization Validation Certificate - Wildcard Comodo Extended Validation Certificate Page 175

182 GE-RAPIDSSL GE-RAPIDSSL-W GE-QUICKSSL GE-QUICKSSLPRO GE-TRUEBIZ GE-TRUEBIZ-W GE-TRUEBIZ-EV VE-SECURESITE VE-SECURESITE-EV VE-SECURESITEPRO VE-SECURESITEPRO-EV TH-SSLWEB TH-SGCSUPER TH-SSLWEB-W TH-SSLWEB-EV GeoTrust Rapid SSL GeoTrust Rapid SSL - Wildcard GeoTrust Quick SSL GeoTrust Quick SSL - Premium GeoTrust True Business ID GeoTrust True Business ID - Wildcard GeoTrust True Business ID with EV VeriSign Secure Site Certificate VeriSign Secure Site Certificate with EV VeriSign Secure Site Certificate Professional VeriSign Secure Site Certificate Pro with EV Thawte SSL Web Server Thawte SGC Super Certificate Thawte SSL Web Server Wildcard Thawte SSL Web Server With EV Page 176

183 APPENDIX I Hosting Products Product Type WEB-WINHOSTING-BASIC WEB-WINHOSTING-PREMIUM WEB-WINHOSTING-UNLIMITED WEB-LINUXHOSTING-BASIC WEB-LINUXHOSTING-PREMIUM WEB-LINUXHOSTING-UNLIMITED Product Description Windows Hosting Basic Package Windows Hosting Premium Package Windows Hosting Unlimited Package Linux Hosting Basic Package Linux Hosting Premium Package Linux Hosting Unlimited Package APPENDIX J Products Product Type 500M 5G 10G Product Description 500MB Package 5G Package 10G Package APPENDIX K Card Types Type VISA VISADEBIT AMEX DISCOVER MAESTRO MASTERCARD Description Visa Card Visa Debit Card American Express Discover Card Maestro Card Master Card Page 177

184 APPENDIX L ecommerce Products Product Type WEB-ECOMMERCE-EXPRESS WEB-ECOMMERCE-PREMIUM Product Description ECommerce Basic Package. ECommerce Premium Package. APPENDIX M Site Builder Products Product Type SITE-BUILDER Product Description Site Builder Basic Package. APPENDIX N Transfer Statuses Type TRANSFERFAILED TRANSFERCANCELLED TRANSFERPENDING TRANSFERCOMPLETE TRANSFERCANCELPENDING TRANSFERPENDINGAUTHCODE TRANSFERPENDINGAPPROVAL TRANSFEROUT TRANSFERPENDINGOPS_WHOIS TRANSFEROUTPENDINGACTIVE TRANSFEROUTPENDINGCANCELLED TRANSFEROUTREJECTED Description Domain transfer failed at the registry. Domain transfer was cancelled. Domain transfer is pending. Domain transfer is completed. Domain transfer was cancelled by a user and is awaiting confirmation from the registry. Awaiting a domain authorisation code. Awaiting approval from the domain registration contact. Domain has transferred to a different registrar. Domain WHOIS was unable to be determined so awaiting Account Manager assistance. Domain is pending a transfer to a different registrar. Domain is pending a transfer to a different registrar. Domain transfer was refused. Page 178

185 APPENDIX O Product Statuses Type ACTIVE DELETED CANCELLED Description Product is ACTIVE. Product is DELETED. Product is CANCELLED and will not auto-renew. APPENDIX P User Account Statuses Type ACTIVE DELETED SUSPENDED Description User account is ACTIVE. User account is DELETED. User account is SUSPENDED. APPENDIX Q Report Types Type Registrations Renewals TransfersIn TransfersOut OrderSummary Expiring Description Returns a list of domain registrations. Returns a list of domain renewals. Returns a list of domain transfers-in. Returns a list of domain transfers-out. Returns summarised orders Returns expiring domains APPENDIX R Certificate Types Type FULFILMENT APPROVER Description The notification sent on a certificateadd. The notification sent on a certificateconfigure. APPENDIX S Site Security Product Types Type SITE-LOCK-BASIC SITE-LOCK-PREMIUM Description The basic Site Lock product The premium Sile Lock product Page 179

186 SITE-LOCK-ENTERPRISE The enterprise Site Lock product APPENDIX T DIFM Product Types Type e-works-doitforme Description The basic DIFM product APPENDIX U Mobile Hosting Product Types Type WEB-MOBILE-HOSTING Description The basic Mobile Hosting product APPENDIX V Certificate Validation Mode Types Type File Description Validates by supplied Approver Address (default) Validates by reading contents in the AuthFile on the site APPENDIX W Certificate Validation Info Nodes n.b. The certificatevalidation XML nodes in the response are present ONLY if the validationmode is anything other than which is the default value. The key is an attribute of the node. Eg. <certificatevalidation key= /> Key key = certfilename key = certfileauthcontents Description The name the file in the root dir of the site must be called The auth contents within the file named above Page 180