API Module Domain retrieveDomainRequest

From Openprovider API documentation

---

Revision as of 14:56, 22 April 2010

Contents 1 Module Domain > Modify 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Domain > Modify

Module	domain
Command name	retrieveDomainRequest
Use	Retrieves information about an existing domain object
Input	domain withAdditionalData
Output	domain orderDate activeDate expirationDate ownerHandle adminHandle techHandle nsGroup nameServers authCode status autoRenew locked type useDomicile additionalData (if withAdditionalData = true)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domain' => array(
      'name' => 'openprovider',
      'extension' => 'nl'
    ),
    'withAdditionalData' => 0
  ));

Raw XML

<?xml version="1.0" encoding="UTF-8"?>
<openxml>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <retrievedomainrequest>
    <domain>
      <name>domain-info</name>
      <extension>nl</extension>
    </domain>
    <withadditionaldata>0</withadditionaldata>
  </retrievedomainrequest>
</openxml>

<?xml version="1.0" encoding="UTF-8"?>
<openxml>
  <reply>
    0
    <desc></desc>
    <data>
      <domain>
        <name>abcdefg4</name>
        <extension>nl</extension>
      </domain>
      <nameservers />
      <id>341105</id>
      <islockable>0</islockable>
      <islocked>0</islocked>
      <comments></comments>
      <orderdate>2010-03-15 16:50:19</orderdate>
      <activedate></activedate>
      <expirationdate></expirationdate>
      <status>FAI</status>
      <canrenew>0</canrenew>
      <autorenew>0</autorenew>
      <ownerhandle>OH002766-NL</ownerhandle>
      <adminhandle>OH002766-NL</adminhandle>
      <techhandle>OH002766-NL</techhandle>
      <nsgroup>opdrs4</nsgroup>
      <type>NEW</type>
      <authcode></authcode>
      <authorizationcoderequired>0</authorizationcoderequired>
      <tradeallowed>1</tradeallowed>
      <restoreprice>70</restoreprice>
      <usedomicile>0</usedomicile>
      <ownername>
        <initials>N.</initials>
        <firstname>Nigel</firstname>
        <prefix></prefix>
        <lastname>Jones</lastname>
      </ownername>
      <ownercompanyname></ownercompanyname>
    </data>
  </reply>
</openxml>