API Module Nsgroup retrieveNsGroupRequest

From Openprovider API documentation

Revision as of 13:24, 5 July 2010 (view source) WikiSysop (Talk | contribs) ← Older edit		Current revision as of 10:51, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Nameserver group > Retrieve)
(4 intermediate revisions not shown)
Line 13:		Line 13:
	|'''Input'''		|'''Input'''
	|		|
-	*'''nsGroup'''	+	*'''[[API Format nsGroup|nsGroup]]'''
	*withDomainCount		*withDomainCount
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''
	|		|
-	*nsGroup	+	*[[API Format nsGroup|nsGroup]]
-	*[[API Format NameServers|nameServers]]	+	*[[API Format Nameservers|nameServers]]
	*domainCount (if withDomainCount = true)		*domainCount (if withDomainCount = true)
	|}		|}
Line 33:		Line 33:
	===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 47:		Line 48:
	<openXML>		<openXML>
	<reply>		<reply>
-	< code>0</code>	+	<nowiki><code>0</code></nowiki>
	<desc></desc>		<desc></desc>
	<data>		<data>

---

Current revision as of 10:51, 17 June 2016

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

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