API Module Domain searchDomainRequest

From Openprovider API documentation

Revision as of 13:15, 6 April 2010 (view source) WikiSysop (Talk | contribs) (Created page with '==Module Domain > Search== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |customer |- style="background-color:#EEEEEE;" |'''Command name''' |se…') ← Older edit		Revision as of 13:15, 6 April 2010 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 32:		Line 32:
	*techHandle		*techHandle
	*nsGroup		*nsGroup
-	*nameServers	+	*[[API Format Nameservers|nameServers]]
	*authCode		*authCode
	*status		*status

---

Revision as of 13:15, 6 April 2010

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

Module Domain > Search

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

to do