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 retrieveDomainRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
Line 35: Line 35:
*type
*type
*useDomicile
*useDomicile
 +
*at
*[[API Format Additional Data Domain|additionalData]] (if withAdditionalData = true)
*[[API Format Additional Data Domain|additionalData]] (if withAdditionalData = true)
*statusDetails (if withStatusDetails = true)
*statusDetails (if withStatusDetails = true)

Revision as of 04:45, 22 November 2011

Contents

Module Domain > Retrieve

Module domain
Command name retrieveDomainRequest
Use Retrieves information about an existing domain object
Input
  • domain
  • withAdditionalData
  • withStatusDetails
Output
  • domain
  • orderDate
  • activeDate
  • expirationDate
  • renewalDate
  • ownerHandle
  • adminHandle
  • techHandle
  • nsGroup
  • nameServers
  • authCode
  • status
  • autoRenew
  • locked
  • type
  • useDomicile
  • at
  • additionalData (if withAdditionalData = true)
  • statusDetails (if withStatusDetails = 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 />
      <expirationDate></expirationDate>
      <renewalDate></renewalDate>
      <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 />
        <lastName>Jones</lastName>
      </ownerName>
      <ownerCompanyName></ownerCompanyName>
    </data>
  </reply>
</openXML>
Views
Personal tools