API Module Domain retrieveDomainRequest

From Openprovider API documentation

Revision as of 08:41, 5 January 2015 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 06:34, 16 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Domain > Retrieve) Newer edit →
Line 24:		Line 24:
	*expirationDate		*expirationDate
	*expirationDateOpenprovider		*expirationDateOpenprovider
-	*ownerHandle	+	*[[API Format Handle|ownerHandle]]
-	*adminHandle	+	*[[API Format Handle|adminHandle]]
-	*techHandle	+	*[[API Format Handle|techHandle]]
-	*billingHandle	+	*[[API Format Handle|billingHandle]]
-	*resellerHandle	+	*[[API Format Handle|resellerHandle]]
	*nsGroup		*nsGroup
	*[[API Format Nameservers|nameServers]]		*[[API Format Nameservers|nameServers]]

---

Revision as of 06:34, 16 June 2016

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 withRegistryDetails
Output	domain orderDate activeDate expirationDate expirationDateOpenprovider ownerHandle adminHandle techHandle billingHandle resellerHandle nsGroup nameServers authCode status autorenew locked type useDomicile at additionalData (if withAdditionalData = true) registryDetails (if withRegistryDetails = true) softQuarantineExpiryDate (if status=DEL or RRQ) hardQuarantineExpiryDate (if status=DEL or RRQ) restorableUntil (if status=DEL or RRQ)

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

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>
  <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>
      <expirationDateOpenprovider></expirationDateOpenprovider>
      <status>FAI</status>
      <canRenew>0</canRenew>
      <autoRenew>0</autoRenew>
      <ownerHandle>OH002766-NL</ownerHandle>
      <adminHandle>OH002766-NL</adminHandle>
      <techHandle>OH002766-NL</techHandle>
      <billingHandle>SR003891-NL</billingHandle>
      <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>