API Module Domain searchDomainRequest

From Openprovider API documentation

Revision as of 14:51, 22 April 2010 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 14:59, 22 April 2010 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 55:		Line 55:
	===Raw XML===		===Raw XML===
-	<?xml version="1.0" encoding="UTF-8"?>	+	<?xml version="1.0" encoding="UTF-8"?>
	<openxml>		<openxml>
	<credentials>		<credentials>

---

Revision as of 14:59, 22 April 2010

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

Module Domain > Search

Module	domain
Command name	searchDomainRequest
Use	Returns a list of domain objects matching search criteria
Input	limit offset extension domainNamePattern contactHandle nsGroupPattern status withAdditionalData
Output	Result set of domain details: 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('searchDomainRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
   'offset' => 50,
   'limit'  => 25,
   'contactHandle' => 'AH009176-US',
   'domainNamePattern' => 'openprovider'
 ));

Raw XML

<?xml version="1.0" encoding="UTF-8"?>
<openxml>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <searchdomainrequest>
    <extension>nl</extension>
    <limit>10</limit>
    <offset>0</offset>
    <orderby>domainName</orderby>
    <order>desc</order>
  </searchdomainrequest>
</openxml>

<?xml version="1.0" encoding="UTF-8"?>
<openxml>
  <reply>
    0
    <desc>
    </desc>
    <data>
      <results>
        <array>
          <item>
            <domain>
              <name>test-free-registration</name>
              <extension>nl</extension>
            </domain>
            <nameservers />
            <id>353146</id>
            <islockable>0</islockable>
            <islocked>0</islocked>
            <comments></comments>
            <orderdate>2010-04-20 16:16:26</orderdate>
            <activedate>2010-04-20 16:16:29</activedate>
            <expirationdate>2011-04-20 14:16:28</expirationdate>
            <status>ACT</status>
            <canrenew>0</canrenew>
            <autorenew>1</autorenew>
            <ownerhandle>NL000115-NL</ownerhandle>
            <adminhandle>NL000115-NL</adminhandle>
            <techhandle>NL000115-NL</techhandle>
            <nsgroup>dns-openprovider</nsgroup>
            <type>NEW</type>
            <authcode>sad08dfdsf</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>Company Ltd</ownercompanyname>
          </item>
          <item>
            <domain>
              <name>test-free-domain</name>
              <extension>nl</extension>
            </domain>
            <nameservers />
            <id>353163</id>
            <islockable>0</islockable>
            <islocked>0</islocked>
            <comments>
            </comments>
            <orderdate>2010-04-20 17:12:47</orderdate>
            <activedate>2010-04-20 17:12:51</activedate>
            <expirationdate>2011-04-20 15:12:50</expirationdate>
            <status>ACT</status>
            <canrenew>0</canrenew>
            <autorenew>1</autorenew>
            <ownerhandle>GB000002-GB</ownerhandle>
            <adminhandle>GB000002-GB</adminhandle>
            <techhandle>GB000002-GB</techhandle>
            <nsgroup>dns-openprovider</nsgroup>
            <type>NEW</type>
            <authcode>sad08dfdsf</authcode>
            <authorizationcoderequired>0</authorizationcoderequired>
            <tradeallowed>1</tradeallowed>
            <restoreprice>70</restoreprice>
            <usedomicile>0</usedomicile>
            <ownername>
              <initials>UK</initials>
              <firstname>Great</firstname>
              <prefix>
              </prefix>
              <lastname>Britain</lastname>
            </ownername>
            <ownercompanyname></ownercompanyname>
          </item>
          <item>
            <domain>
              <name>abcdefg</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>2011-03-15 16:50:19</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>88sdkjhf7</authcode>
            <authorizationcoderequired>0</authorizationcoderequired>
            <tradeallowed>1</tradeallowed>
            <restoreprice>70</restoreprice>
            <usedomicile>0</usedomicile>
            <ownername>
              <initials>I.</initials>
              <firstname>Ibrahim</firstname>
              <prefix></prefix>
              <lastname>Smith</lastname>
            </ownername>
            <ownercompanyname></ownercompanyname>
          </item>
        </array>
      </results>
      <total>3</total>
    </data>
  </reply>
</openxml>