API Module Nsgroup searchNsGroupRequest

From Openprovider API documentation

Revision as of 10:49, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Nameserver group > Search) ← Older edit		Revision as of 10:50, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Nameserver group > Search) Newer edit →
Line 23:		Line 23:
	|Result set of extension details:		|Result set of extension details:
	*[[API Format nsGroup|nsGroup]]		*[[API Format nsGroup|nsGroup]]
-	*[[API Format Nameservers|nameServers]]	+	*[[API Format nameServers|nameServers]]
	*domainCount (if withDomainCount = true)		*domainCount (if withDomainCount = true)
	|}		|}

---

Revision as of 10:50, 17 June 2016

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

Module Nameserver group > Search

Module	Nameserver group
Command name	searchNsGroupRequest
Use	Returns a list of nameserver group objects matching search criteria
Input	limit (default value: 100, maximum value: 1000) offset (default value: 0) nsGroupPattern (to search for all nameserver groups with matching name pattern) nsNamePattern (to search for all nameserver groups with nameservers matching hostname pattern) nsIpPattern (to search for all nameserver groups with nameservers matching IP address pattern) withDomainCount (default value: 0)
Output	Result set of extension details: nsGroup nameServers domainCount (if withDomainCount = true)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchNsGroupRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
  ));

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>
  <searchNsGroupRequest />
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>
      <results>
        <array>
          <item>
            <nameServers>
              <array>
                <item>
                  <name>ns1.openprovider.nl</name>
                  <ip>89.255.7.30</ip>
                </item>
                <item>
                  <name>ns2.openprovider.be</name>
                  <ip>89.255.6.30</ip>
                </item>
                <item>
                  <name>ns3.openprovider.eu</name>
                  <ip>80.95.170.252</ip>
                </item>  
              </array>
            </nameServers>
            <nsGroup>server-tux</nsGroup>
            <nsCount>3</nsCount>
          </item>
        </array>
      </results>
      <total>1</total>
    </data>
  </reply>
</openXML>