API Module Domain tradeDomainRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 18:34, 23 December 2020

Module Domain > Trade

Module	domain
Command name	tradeDomainRequest
Use	Changes the owner of an existing domain
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) authCode 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 or 1, default value is 0) autorenew ( on \| off \| default ) promoCode
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>

@@ Line 14: / Line 14: @@
 |
 *'''[[API Format Domain|domain]]'''
-*'''period'''
+*[[API Format Period|period]]
-*'''ownerHandle'''
+*'''[[API Format Handle|ownerHandle]]''' (customer unique identifier or [[API Format Handle|handle]])
-*'''adminHandle'''
+*'''[[API Format Handle|adminHandle]]''' (customer unique identifier or [[API Format Handle|handle]])
-*'''techHandle'''
+*'''[[API Format Handle|techHandle]]''' (customer unique identifier or [[API Format Handle|handle]])
-*nsGroup
+*[[API Format Handle|billingHandle]] (customer unique identifier or [[API Format Handle|handle]])
-*nsTemplateName
+*[[API Format Handle|resellerHandle]] (customer unique identifier or [[API Format Handle|handle]])
-*[[API Format Nameservers|nameServers]]
+*[[API Format authCode|authCode]]
-*useDomicile
+*'''[[API Format nsGroup|nsGroup]]''' ('nameserver group', use ''dns-openprovider'' if you want to use our nameservers. Mandatory field only if nameServers field is empty)
+*[[API Format nsTemplateName|nsTemplateName]] (name of the template to use to automatically create DNS zone on the domain; only applicable if nsGroup is ''dns-openprovider'')
+*'''[[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 DNSSEC Keys|dnssecKeys]] (when using your own nameservers)
+*[[API Format useDomicile|useDomicile]] (''0'' or ''1'', default value is ''0'')
+*[[API Format autorenew|autorenew]] ''( on | off | default )''
 *promoCode
-*[[API Format DNSSEC Keys|dnssecKeys]]
 |- style="vertical-align:top;"
 |'''Output'''
 |
-*status
+*status ''(ACT - active or REQ - requested)''
-*expirationDate
+*[[API Format expirationDate|expirationDate]] ''(available only in case of a succeeded realtime domain trade)''
-*renewalDate
+*[[API Format expirationDateOpenprovider|expirationDateOpenprovider]] ''(available only in case of a succeeded realtime domain trade)''
 |}
@@ Line 41: / Line 46: @@
       'adminHandle' => 'SR003891-NL',
       'techHandle' => 'SR003891-NL',
+     'billingHandle' => 'SR003891-NL',
       'domain' => array(
         'name' => 'openprovider',
@@ Line 60: / Line 66: @@
       <adminHandle>SR003891-NL</adminHandle>
       <techHandle>SR003891-NL</techHandle>
+     <billingHandle>SR003891-NL</billingHandle>
       <domain>
         <name>openprovider</name>