API Module Domain tradeDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 06:51, 16 June 2016

Module Domain > Trade

Module	domain
Command name	tradeDomainRequest
Use	Changes the owner of an existing domain
Input	domain period ownerHandle adminHandle techHandle billingHandle resellerHandle authCode nsGroup nsTemplateName nameServers isDnssecEnabled (0 (default) or 1 - Only usable with nameservers of Openprovider) useDomicile promoCode dnssecKeys
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 31: / Line 31: @@
 |'''Output'''
 |
-*status
+*status ''(ACT - active or REQ - requested)''
-*expirationDate
+*[[API Format expirationDate|expirationDate]] ''(available only in case of a succeeded realtime domain trade)''
-*expirationDateOpenprovider
+*[[API Format expirationDateOpenprovider|expirationDateOpenprovider]] ''(available only in case of a succeeded realtime domain trade)''
 |}