API Module Nameserver searchZoneDnsRequest

From Openprovider API documentation

Revision as of 09:23, 14 July 2010 (view source) WikiSysop (Talk | contribs) (Created page with '==Module DNS zone > Search== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |DNS zone |- style="background-color:#EEEEEE;" |'''Command name''' |…') ← Older edit		Current revision as of 11:04, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Module DNS zone > Search)
(5 intermediate revisions not shown)
Line 13:		Line 13:
	|'''Input'''		|'''Input'''
	|		|
-	*limit	+	*[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'')
-	*offset	+	*[[API Format Offset|offset]] (''default value: 0'')
	*namePattern		*namePattern
	*type (''master'' or ''slave'')		*type (''master'' or ''slave'')
-	*withRecords	+	*withRecords (''default value: 0'')
-	*withHistory	+	*withHistory (''default value: 0'')
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''
	|Result set of DNS zone details:		|Result set of DNS zone details:
-	*type	+	*type (''master'' or ''slave'')
	*name		*name
	*ip		*ip
Line 41:		Line 41:
	===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>
Line 55:		Line 56:
	<openXML>		<openXML>
	<reply>		<reply>
-	< code>0</code>	+	<nowiki><code>0</code></nowiki>
	<desc></desc>		<desc></desc>
	<data>		<data>

---

Current revision as of 11:04, 17 June 2016

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

Module DNS zone > Search

Module	DNS zone
Command name	searchZoneDnsRequest
Use	Returns a list of DNS zone objects matching search criteria
Input	limit (default value: 100, maximum value: 1000) offset (default value: 0) namePattern type (master or slave) withRecords (default value: 0) withHistory (default value: 0)
Output	Result set of DNS zone details: type (master or slave) name ip creationDate modificationDate records (if withRecords = true) history (if withHistory = true)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchZoneDnsRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'namePattern' => '%demo%'
  ));

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>
  <searchZoneDnsRequest>
    <namePattern>%demo%</namePattern>
  </searchZoneDnsRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>
      <results>
        <array>
          <item>
            <id>48890</id>
            <type>master</type>
            <name>demozone.com</name>
            <ip>89.255.0.43</ip>
            <active>1</active>
            <creationDate>2010-07-13 17:07:22</creationDate>
            <modificationDate>2010-07-13 17:07:22</modificationDate>
          </item>
        </array>
      </results>
      <total>1</total>
    </data>
  </reply>
</openXML>