API Module Domain deleteDomainRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 06:29, 17 June 2016

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 not all TLDs support reactivation option and when available this option could be quite expensive. Domains with status FAI can be deleted to get a refund of the paid amount.
Input	domain id (domain ID, only required if there are two identical domains in your account, for example pre-registrations) type
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

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

@@ Line 10: / Line 10: @@
 |'''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 not all TLDs support reactivation option and sometimes this option is quite expensive.
+*In case of '''registered domains''' with status ACT, this will result in a deletion at the registry. Keep in mind that not all TLDs support reactivation option and when available this option could be quite expensive.
 *Domains with status '''FAI''' can be deleted to get a refund of the paid amount.
 |- style="vertical-align:top;"