API Module Domain createDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 08:01, 13 December 2012

Module Domain > Create

Module	domain
Command name	createDomainRequest
Use	Registers a domain with the provided data
Input	domain period ownerHandle adminHandle techHandle nsGroup nsTemplateName nameServers useDomicile (0 (default) or 1) promoCode autorenew (default (default), on or off) comments isDnssecEnabled (0 (default) or 1) dnssecKeys
Output	status authCode activationDate (only in case of a succeeded realtime domain registration) expirationDate (only in case of a succeeded realtime domain registration) renewalDate (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',
    'domain' => array(
      'name' => 'this-domain-is-registered',
      'extension' => 'com'
    ),
    'period' => '1',
    'nsGroup' => 'dns-openprovider',
    'nsTemplateName' => 'Shared hosting server Apollo',
    'isDnssecEnabled' => 1,
  ));

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>
    <domain>
      <name>this-domain-is-registered</name>
      <extension>com</extension>
    </domain>
    <period>1</period>
    <nsGroup>dns-openprovider</nsGroup>
    <nsTemplateName>Shared hosting server Apollo</nsTemplateName>
    <isDnssecEnabled>1</isDnssecEnabled>
  </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>
      <renewalDate>2012-04-22 14:41:32</renewalDate>
      <authCode>123456</authCode>
    </data>
  </reply>
</openXML>

@@ Line 23: / Line 23: @@
 *useDomicile (''0'' (default) or ''1'')
 *promoCode
+*autorenew (''default'' (default), ''on'' or ''off'')
+*comments
+*isDnssecEnabled (''0'' (default) or ''1'')
+*[[API Format DNSSEC Keys|dnssecKeys]]
 |- style="vertical-align:top;"
 |'''Output'''
@@ Line 49: / Line 53: @@
       'nsGroup' => 'dns-openprovider',
       'nsTemplateName' => 'Shared hosting server Apollo',
+     'isDnssecEnabled' => 1,
     ));
@@ Line 70: / Line 75: @@
       <nsGroup>dns-openprovider</nsGroup>
       <nsTemplateName>Shared hosting server Apollo</nsTemplateName>
+     <isDnssecEnabled>1</isDnssecEnabled>
     </createDomainRequest>
   </openXML>