API Module Domain retrieveDomainRequest

From Openprovider API documentation

Revision as of 13:56, 30 September 2011 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 07:44, 31 October 2011 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 23:		Line 23:
	*activeDate		*activeDate
	*expirationDate		*expirationDate
		+	*renewalDate
	*ownerHandle		*ownerHandle
	*adminHandle		*adminHandle
Line 85:		Line 86:
	<activeDate />		<activeDate />
	<expirationDate></expirationDate>		<expirationDate></expirationDate>
		+	<renewalDate></renewalDate>
	<status>FAI</status>		<status>FAI</status>
	<canRenew>0</canRenew>		<canRenew>0</canRenew>

---

Revision as of 07:44, 31 October 2011

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

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 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>