API Module Domain deleteDomainRequest
From Openprovider API documentation
(Difference between revisions)
(Created page with '==Module Domain > Delete== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |domain |- style="background-color:#EEEEEE;" |'''Command name''' |dele…') |
(→Module Domain > Delete) |
||
| (9 intermediate revisions not shown) | |||
| Line 10: | Line 10: | ||
|'''Use''' | |'''Use''' | ||
|Deletes a domain name. | |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 | + | *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 ''' | + | *Domains with status '''FAI''' can be deleted to get a refund of the paid amount. |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
*'''[[API Format Domain|domain]]''' | *'''[[API Format Domain|domain]]''' | ||
| + | *id (''domain ID, only required if there are two identical domains in your account, for example pre-registrations'') | ||
| + | *[[API Format type|type]] | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
| Line 35: | Line 37: | ||
===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> |
<credentials> | <credentials> | ||
<username>username</username> | <username>username</username> | ||
<password>password</password> | <password>password</password> | ||
</credentials> | </credentials> | ||
| - | < | + | <deleteDomainRequest> |
<domain> | <domain> | ||
<name>domain-to-delete</name> | <name>domain-to-delete</name> | ||
<extension>nl</extension> | <extension>nl</extension> | ||
</domain> | </domain> | ||
| - | </ | + | </deleteDomainRequest> |
| - | </ | + | </openXML> |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| - | < | + | <openXML> |
<reply> | <reply> | ||
| - | <code>0</code> | + | <nowiki><code>0</code></nowiki> |
<desc></desc> | <desc></desc> | ||
</reply> | </reply> | ||
| - | </ | + | </openXML> |
Current revision as of 06:29, 17 June 2016
Contents |
Module Domain > Delete
| Module | domain |
| Command name | deleteDomainRequest |
| Use | Deletes a domain name.
|
| Input | |
| 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>