API Module Domain createDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 11:22, 10 June 2016

Module Domain > Create

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', mandatory field only if nameServers field is empty) nsTemplateName (name of the template to use to automatically create DNS zone on the domain) nameServers (mandatory field only if nsGroup field is empty) isDnssecEnabled (0 (default) or 1 - Only accepted when nameservers of Openprovider are used) useDomicile (0 (default) or 1, enables use of domicile or trustee address for TLD that require local presence) isPrivateWhoisEnabled (0 (default) or 1, enables whois privacy on domain) promoCode autorenew (default (default), on or off) comments dnssecKeys additionalData (mandatory for some TLDs) applicationMode (required for new gTLDs; allowed values: sunrise (during the Sunrise of a new gTLD launch only; special fees may apply; it's required to submit an SMD file in the applicationSmd parameter) landrush (during the Landrush of a new gTLD launch only; special fees may apply) preregistration (during the period in which Openprovider accepts pre-registrations for the TLD) claims (during the Trademark Claims period for the TLD; details can be found on the TLD details pages via the overview page)
Output	status (ACT - active or REQ - requested) authCode (EPP code that is required for domain transfer, only in case if TLD supports it) activationDate (only in case of a succeeded realtime domain registration) expirationDate (registry expiration date, available only in case of a succeeded realtime domain registration) expirationDateOpenprovider (date till which domain has to be renewed by reseller in Openprovider, 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',
    'nsTemplateName' => 'Shared hosting server Apollo',
  ));

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.

<?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>
    <nsTemplateName>Shared hosting server Apollo</nsTemplateName>
  </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>

@@ Line 20: / Line 20: @@
 *[[API Format Handle|billingHandle]] (customer unique identifier or [[API Format Handle|handle]])
 *[[API Format Handle|resellerHandle]] (customer unique identifier or [[API Format Handle|handle]])
-*'''nsGroup''' ('nameserver group', mandatory field only if nameServers field is empty)
+*'''[[API Format Handle|nsGroup]]''' ('nameserver group', mandatory field only if nameServers field is empty)
-*nsTemplateName (name of the template to use to automatically create DNS zone on the domain)
+*[[API Format Handle|nsTemplateName]] (name of the template to use to automatically create DNS zone on the domain)
 *'''[[API Format Nameservers|nameServers]]''' (mandatory field only if nsGroup field is empty)
-*isDnssecEnabled (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used)
+*[[API Format Handle|isDnssecEnabled]] (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used)
-*useDomicile (''0'' (default) or ''1'', enables use of domicile or trustee address for TLD that require local presence)
+*[[API Format useDomicile|useDomicile]] (''0'' (default) or ''1'', enables use of domicile or trustee address for TLD that require local presence)
-*isPrivateWhoisEnabled (''0'' (default) or ''1'', enables whois privacy on domain)
+*[[API Format isPrivateWhoisEnabled|isPrivateWhoisEnabled]] (''0'' (default) or ''1'', enables whois privacy on domain)
 *promoCode
 *autorenew (''default'' (default), ''on'' or ''off'')
@@ Line 31: / Line 31: @@
 *[[API Format DNSSEC Keys|dnssecKeys]]
 *[[API Format Additional Data|additionalData]] (mandatory for some TLDs)
-*applicationMode (''required for new gTLDs; allowed values:
+*[[API Format applicationMode|applicationMode]] (''required for new gTLDs; allowed values:
 ** ''sunrise'' (during the Sunrise of a new gTLD launch only; special fees may apply; it's required to submit an SMD file in the ''applicationSmd'' parameter)
 ** ''landrush'' (during the Landrush of a new gTLD launch only; special fees may apply)