API Module Domain createDomainRequest

From Openprovider API documentation

Contents 1 Module Domain > Create 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Domain > Create

Fields marked in bold are mandatory. Prior to use this API method make sure if the domain TLD requires additional data for domain owner to be filled in.

Module	domain
Command name	createDomainRequest
Use	Registers a domain name with the attributes provided
Input	domain period ownerHandle (customer unique identifier or handle) adminHandle (customer unique identifier or handle) techHandle (customer unique identifier or handle) billingHandle (customer unique identifier or handle) resellerHandle (customer unique identifier or handle) nsGroup ('nameserver group', use dns-openprovider if you want to use our nameservers. Mandatory field only if nameServers field is empty) nsTemplateName (name of the template to use to automatically create DNS zone on the domain; only applicable if nsGroup is dns-openprovider) nameServers (mandatory field only if nsGroup field is empty) isDnssecEnabled (0 (default) or 1 - Only accepted when nameservers of Openprovider are used) dnssecKeys (when using your own nameservers) useDomicile (0 (default) or 1) acceptPremiumFee (required in case when domain is premium, value is the price returned in the response for createDomainRequest without acceptPremiumFee) isPrivateWhoisEnabled (0 or 1, default value is 0) promoCode autorenew ( on | off | default ) comments additionalData (mandatory for some TLDs) applicationMode (required for new gTLDs)
Output	status (ACT - active or REQ - requested) authCode (only in case if TLD supports it) activationDate (available only in case of a succeeded realtime domain registration) expirationDate (available only in case of a succeeded realtime domain registration) expirationDateOpenprovider (Same as renewalDate. Available only in case of a succeeded realtime domain registration) renewalDate (Date when a domain expires at Openprovider. This date should be referred for domain expiration and renewals.available only in case of a succeeded realtime domain registration)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('createDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'ownerHandle' => 'SR003891-NL',
    'adminHandle' => 'SR003891-NL',
    'techHandle' => 'SR003891-NL',
    'billingHandle' => 'SR003891-NL',
    'domain' => array(
      'name' => 'this-domain-is-registered',
      'extension' => 'com'
    ),
    'period' => '1',
    'nsGroup' => 'dns-openprovider',
  ));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

NB: When submitting multiple domain names in an array, the <domains> (plural) XML field should be used instead of <domain>.

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <createDomainRequest>
    <ownerHandle>SR003891-NL</ownerHandle>
    <adminHandle>SR003891-NL</adminHandle>
    <techHandle>SR003891-NL</techHandle>
    <billingHandle>SR003891-NL</billingHandle>
    <domain>
      <name>this-domain-is-registered</name>
      <extension>com</extension>
    </domain>
    <period>1</period>
    <nsGroup>dns-openprovider</nsGroup>
  </createDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <status>ACT</status>
      <activationDate>2011-04-22 14:14:32</activationDate>
      <expirationDate>2012-04-22 14:41:32</expirationDate>
      <expirationDateOpenprovider>2012-04-22 14:41:32</expirationDateOpenprovider>
      <authCode>123456</authCode>
    </data>
  </reply>
</openXML>

Output example for the attempt to register premium domain without parameter acceptPremiumFee:

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>379</code>
    <desc>You are about to register the premium domain. If you accept this registration fee, re-send the createDomainRequest and add the parameters "acceptPremiumFee" with the value of a premium fee, which can be found in the `data` block of this command output.</desc>
    <data>33</data>
  </reply>
</openXML>