This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Module Domain tradeDomainRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Module Domain > Trade)
(Module Domain > Trade)
Line 21: Line 21:
*[[API Format Handle|resellerHandle]] (customer unique identifier or [[API Format Handle|handle]])
*[[API Format Handle|resellerHandle]] (customer unique identifier or [[API Format Handle|handle]])
*[[API Format authCode|authCode]]
*[[API Format authCode|authCode]]
-
*'''[[API Format Handle|nsGroup]]''' ('nameserver group', mandatory field only if nameServers field is empty)
+
*'''[[API Format nsGroup|nsGroup]]''' ('nameserver group', mandatory field only if nameServers field is empty)
-
*[[API Format Handle|nsTemplateName]] (name of the template to use to automatically create DNS zone on the domain)
+
*[[API Format nsTemplateName|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)
+
*'''[[API Format nameServers|nameServers]]''' (mandatory field only if nsGroup field is empty)
*[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used)
*[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used)
*[[API Format useDomicile|useDomicile]] (''0'' or ''1'', default value is ''0'')
*[[API Format useDomicile|useDomicile]] (''0'' or ''1'', default value is ''0'')

Revision as of 06:59, 16 June 2016

Contents

Module Domain > Trade

Module domain
Command name tradeDomainRequest
Use Changes the owner of an existing domain
Input
Output
  • status (ACT - active or REQ - requested)
  • expirationDate (available only in case of a succeeded realtime domain trade)
  • expirationDateOpenprovider (available only in case of a succeeded realtime domain trade)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('tradeDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'ownerHandle' => 'SR003891-NL',
    'adminHandle' => 'SR003891-NL',
    'techHandle' => 'SR003891-NL',
    'billingHandle' => 'SR003891-NL',
    'domain' => array(
      'name' => 'openprovider',
      'extension' => 'nl'
    ),
    'nsGroup' => 'MyServer',
  ));

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>
  <tradeDomainRequest>
    <ownerHandle>SR003891-NL</ownerHandle>
    <adminHandle>SR003891-NL</adminHandle>
    <techHandle>SR003891-NL</techHandle>
    <billingHandle>SR003891-NL</billingHandle>
    <domain>
      <name>openprovider</name>
      <extension>nl</extension>
    </domain>
    <nsGroup>MyServer</nsGroup>
  </tradeDomainRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>364</code>
    <desc>Owner handle must differ from the current one.</desc>
    <data />
  </reply>
</openXML>
Views
Personal tools