API Module Nsgroup deleteNsGroupRequest

From Openprovider API documentation

Revision as of 10:53, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Nameserver group > Delete) ← Older edit		Current revision as of 10:53, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Raw XML)
(One intermediate revision not shown)
Line 13:		Line 13:
	|'''Input'''		|'''Input'''
	|		|
-	*[[API Format nsGroup|nsGroup]]	+	*'''[[API Format nsGroup|nsGroup]]'''
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''
Line 45:		Line 45:
	<openXML>		<openXML>
	<reply>		<reply>
-	< code>0</code>	+	<nowiki><code>0</code></nowiki>
	<desc></desc>		<desc></desc>
	</reply>		</reply>
	</openXML>		</openXML>

---

Current revision as of 10:53, 17 June 2016

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

Module Nameserver group > Delete

Module	Nameserver group
Command name	deleteNsGroupRequest
Use	Deletes an existing nameserver group object; will only succeed if no domains are linked to this nameserver group
Input	nsGroup
Output	-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('deleteNsGroupRequest')
  ->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>
  <deleteNsGroupRequest>
    <nsGroup>server-tux</nsGroup>
  </deleteNsGroupRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
  </reply>
</openXML>