API Module Nsgroup retrieveNsGroupRequest

From Openprovider API documentation

Revision as of 13:21, 5 July 2010 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 13:24, 5 July 2010 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 13:		Line 13:
	|'''Input'''		|'''Input'''
	|		|
-	*nsGroup	+	*'''nsGroup'''
	*withDomainCount		*withDomainCount
	|- style="vertical-align:top;"		|- style="vertical-align:top;"

---

Revision as of 13:24, 5 July 2010

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

Module Nameserver group > Retrieve

Module	Nameserver group
Command name	retrieveNsGroupRequest
Use	Retrieves information about an existing nameserver group object
Input	nsGroup withDomainCount
Output	nsGroup nameServers domainCount (if withDomainCount = true)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveNsGroupRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'nsGroup' => 'server-tux',
  ));

Raw XML

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <retrieveNsGroupRequest>
    <nsGroup>server-tux</nsGroup>
  </retrieveNsGroupRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <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>
        </array>
      </nameServers>
      <nsGroup>server-tux</nsGroup>
      <nsCount>3</nsCount>
    </data>
  </reply>
</openXML>