API Module Domain deleteDomainRequest

From Openprovider API documentation

Revision as of 15:21, 22 April 2010 (view source) WikiSysop (Talk | contribs) (Created page with '==Module Domain > Delete== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |domain |- style="background-color:#EEEEEE;" |'''Command name''' |dele…') ← Older edit		Revision as of 13:47, 1 July 2010 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 36:		Line 36:
	===Raw XML===		===Raw XML===
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
-	<openxml>	+	<openXML>
	<credentials>		<credentials>
	<username>username</username>		<username>username</username>
	<password>password</password>		<password>password</password>
	</credentials>		</credentials>
-	<deletedomainrequest>	+	<deleteDomainRequest>
	<domain>		<domain>
	<name>domain-to-delete</name>		<name>domain-to-delete</name>
	<extension>nl</extension>		<extension>nl</extension>
	</domain>		</domain>
-	</deletedomainrequest>	+	</deleteDomainRequest>
-	</openxml>	+	</openXML>
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
-	<openxml>	+	<openXML>
	<reply>		<reply>
-	<code>0</code>	+	< code>0</code>
	<desc></desc>		<desc></desc>
	</reply>		</reply>
-	</openxml>	+	</openXML>

---

Revision as of 13:47, 1 July 2010

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

Module Domain > Delete

Module	domain
Command name	deleteDomainRequest
Use	Deletes a domain name. In case of registered domains with status ACT, this will result in a deletion at the registry. Keep in mind that reactivation is not always an option, and if it is, it is sometimes quite expensive. Domains with status PEN or FAI can be deleted to get a refund of the paid amount.
Input	domain
Output	-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('deleteDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domain' => array(
      'name' => 'domain-to-delete',
      'extension' => 'nl'
    )
  ));

Raw XML

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <deleteDomainRequest>
    <domain>
      <name>domain-to-delete</name>
      <extension>nl</extension>
    </domain>
  </deleteDomainRequest>
</openXML>

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