API Module Nsgroup searchNsGroupRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 11:12, 23 March 2012

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 offset default value: 0 nsGroupPattern nsNamePattern nsIpPattern 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>

@@ Line 36: / Line 36: @@
 ===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>