API Module Domain searchDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Search) |
(→Module Domain > Search) |
||
| Line 19: | Line 19: | ||
*[[API Format Handle|contactHandle]] (will return domains with customer handle match of any handle type: owner, admin, tech or billing) | *[[API Format Handle|contactHandle]] (will return domains with customer handle match of any handle type: owner, admin, tech or billing) | ||
*nsGroupPattern | *nsGroupPattern | ||
| - | *[[API Format | + | *[[API Format Domain Status|status]] |
*withAdditionalData ''default value: 0'' | *withAdditionalData ''default value: 0'' | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
Revision as of 07:33, 17 June 2016
Contents |
Module Domain > Search
| Module | domain |
| Command name | searchDomainRequest |
| Use | Returns a list of domain objects matching search criteria |
| Input |
|
| Output | Result set of domain details:
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('searchDomainRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'offset' => 50, //Will only return results if more than 50 domains found
'limit' => 25,
'contactHandle' => 'AH009176-US',
'domainNamePattern' => 'openprovider'
));
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>
<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>
< code>0</code>
<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>
<expirationDateOpenprovider>2011-04-20 14:16:28</expirationDateOpenprovider>
<status>ACT</status>
<canRenew>0</canRenew>
<autoRenew>1</autoRenew>
<ownerHandle>NL000115-NL</ownerHandle>
<adminHandle>NL000115-NL</adminHandle>
<techHandle>NL000115-NL</techHandle>
<billingHandle>SR003891-NL</billingHandle>
<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 />
<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 />
<orderDate>2010-04-20 17:12:47</orderDate>
<activeDate>2010-04-20 17:12:51</activeDate>
<expirationDate>2011-04-20 15:12:50</expirationDate>
<expirationDateOpenprovider>2011-04-20 15:12:50</expirationDateOpenprovider>
<status>ACT</status>
<canRenew>0</canRenew>
<autoRenew>1</autoRenew>
<ownerHandle>GB000002-GB</ownerHandle>
<adminHandle>GB000002-GB</adminHandle>
<techHandle>GB000002-GB</techHandle>
<billingHandle>SR003891-NL</billingHandle>
<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 />
<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 />
<orderDate>2010-03-15 16:50:19</orderDate>
<activeDate />
<expirationDate>2011-03-15 16:50:19</expirationDate>
<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>88sdkjhf7</authCode>
<authorizationCodeRequired>0</authorizationCodeRequired>
<tradeAllowed>1</tradeAllowed>
<restorePrice>70</restorePrice>
<useDomicile>0</useDomicile>
<ownerName>
<initials>I.</initials>
<firstName>Ibrahim</firstName>
<prefix />
<lastName>Smith</lastName>
</ownerName>
<ownerCompanyName></ownerCompanyName>
</item>
</array>
</results>
<total>3</total>
</data>
</reply>
</openXML>