API Module Domain retrieveDomainRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Domain > Modify== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |domain |- style="background-color:#EEEEEE;" |'''Command name''' |retr…')
 
(26 intermediate revisions not shown)
Line 1: Line 1:
-
==Module Domain > Modify==
+
==Module Domain > Retrieve==
{| border="1" cellpadding="4"
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
Line 15: Line 15:
*[[API Format Domain|domain]]
*[[API Format Domain|domain]]
*withAdditionalData
*withAdditionalData
 +
*withRegistryDetails
 +
*withWhoisPrivacyData
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 22: Line 24:
*activeDate
*activeDate
*expirationDate
*expirationDate
-
*ownerHandle
+
*expirationDateOpenprovider - Same as renewalDate.
-
*adminHandle
+
*renewalDate - Date when a domain expires at Openprovider. This date should be referred for domain expiration and renewals.
-
*techHandle
+
*[[API Format Handle|ownerHandle]]
-
*nsGroup
+
*[[API Format Handle|adminHandle]]
 +
*[[API Format Handle|techHandle]]
 +
*[[API Format Handle|billingHandle]]
 +
*[[API Format Handle|resellerHandle]]
 +
*[[API Format nsGroup|nsGroup]]
*[[API Format Nameservers|nameServers]]
*[[API Format Nameservers|nameServers]]
-
*authCode
+
*[[API Format authCode|authCode]]
-
*status
+
*[[API Format Domain Status|status]]
-
*autoRenew
+
*[[API Format autorenew|autorenew]]
-
*locked
+
*[[API Format isLocked|isLocked]]
-
*type
+
*[[API Format useDomicile|useDomicile]]
-
*useDomicile
+
*[[API Format Transfer At|at]]
-
*[[API Format Additional Data Domain|additionalData]] (if withAdditionalData = true)
+
*[[API Format Additional Data|additionalData]] (if withAdditionalData = true)
 +
*[[API Format Whois Privacy Data|whoisPrivacyData]] (if withWhoisPrivacyData = true)
 +
*registryDetails (if withRegistryDetails = true)
 +
*softQuarantineExpiryDate (if status=DEL or RRQ)
 +
*hardQuarantineExpiryDate (if status=DEL or RRQ)
 +
*restorableUntil (if status=DEL or RRQ)
|}
|}
Line 50: Line 61:
===Raw XML===
===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"?>
  <?xml version="1.0" encoding="UTF-8"?>
-
  <openxml>
+
  <openXML>
   <credentials>
   <credentials>
     <username>username</username>
     <username>username</username>
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <retrievedomainrequest>
+
   <retrieveDomainRequest>
     <domain>
     <domain>
       <name>domain-info</name>
       <name>domain-info</name>
       <extension>nl</extension>
       <extension>nl</extension>
     </domain>
     </domain>
-
     <withadditionaldata>0</withadditionaldata>
+
     <withadditionalData>0</withadditionalData>
-
   </retrievedomainrequest>
+
   </retrieveDomainRequest>
-
  </openxml>
+
  </openXML>
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
-
  <openxml>
+
  <openXML>
   <reply>
   <reply>
     <code>0</code>
     <code>0</code>
Line 75: Line 87:
         <extension>nl</extension>
         <extension>nl</extension>
       </domain>
       </domain>
-
       <nameservers />
+
       <nameServers />
       <id>341105</id>
       <id>341105</id>
-
       <islockable>0</islockable>
+
       <isLockable>0</isLockable>
-
       <islocked>0</islocked>
+
       <isLocked>0</isLocked>
       <comments></comments>
       <comments></comments>
-
       <orderdate>2010-03-15 16:50:19</orderdate>
+
       <orderDate>2010-03-15 16:50:19</orderDate>
-
       <activedate></activedate>
+
       <activeDate />
-
       <expirationdate></expirationdate>
+
      <expirationDate></expirationDate>
 +
       <expirationDateOpenprovider></expirationDateOpenprovider>
       <status>FAI</status>
       <status>FAI</status>
-
       <canrenew>0</canrenew>
+
       <canRenew>0</canRenew>
-
       <autorenew>0</autorenew>
+
       <autoRenew>0</autoRenew>
-
       <ownerhandle>OH002766-NL</ownerhandle>
+
       <ownerHandle>OH002766-NL</ownerHandle>
-
       <adminhandle>OH002766-NL</adminhandle>
+
       <adminHandle>OH002766-NL</adminHandle>
-
       <techhandle>OH002766-NL</techhandle>
+
       <techHandle>OH002766-NL</techHandle>
-
       <nsgroup>opdrs4</nsgroup>
+
       <billingHandle>SR003891-NL</billingHandle>
 +
      <nsGroup>opdrs4</nsGroup>
       <type>NEW</type>
       <type>NEW</type>
-
       <authcode></authcode>
+
       <authCode></authCode>
-
       <authorizationcoderequired>0</authorizationcoderequired>
+
       <authorizationCodeRequired>0</authorizationCodeRequired>
-
       <tradeallowed>1</tradeallowed>
+
       <tradeAllowed>1</tradeAllowed>
-
       <restoreprice>70</restoreprice>
+
       <restorePrice>70</restorePrice>
-
       <usedomicile>0</usedomicile>
+
       <useDomicile>0</useDomicile>
-
       <ownername>
+
       <ownerName>
         <initials>N.</initials>
         <initials>N.</initials>
-
         <firstname>Nigel</firstname>
+
         <firstName>Nigel</firstName>
-
         <prefix></prefix>
+
         <prefix />
-
         <lastname>Jones</lastname>
+
         <lastName>Jones</lastName>
-
       </ownername>
+
       </ownerName>
-
       <ownercompanyname></ownercompanyname>
+
       <ownerCompanyName></ownerCompanyName>
     </data>
     </data>
   </reply>
   </reply>
-
  </openxml>
+
  </openXML>

Current revision as of 08:51, 19 August 2025

Contents

Module Domain > Retrieve

Module domain
Command name retrieveDomainRequest
Use Retrieves information about an existing domain object
Input
  • domain
  • withAdditionalData
  • withRegistryDetails
  • withWhoisPrivacyData
Output

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>
Retrieved from "https://doc.openprovider.eu/API_Module_Domain_retrieveDomainRequest"
Views
Personal tools