API Module Customer deleteCustomerRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Customer > Delete) |
|||
| (3 intermediate revisions not shown) | |||
| Line 9: | Line 9: | ||
|- | |- | ||
|'''Use''' | |'''Use''' | ||
| - | |Deletes an existing customer object; will only succeed if no domains are linked to this customer | + | |Deletes an existing customer object; will only succeed if no domains (or other objects) are linked to this customer handle |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
| - | *'''handle''' | + | *'''[[API Format Handle|handle]]''' |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
| Line 30: | Line 30: | ||
===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> | ||
| - | < | + | <deleteCustomerRequest> |
<handle>JH000001-US</handle> | <handle>JH000001-US</handle> | ||
| - | </ | + | </deleteCustomerRequest> |
| - | </ | + | </openXML> |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| - | < | + | <openXML> |
<reply> | <reply> | ||
< code>0</code> | < code>0</code> | ||
| Line 48: | Line 49: | ||
<data>1</data> | <data>1</data> | ||
</reply> | </reply> | ||
| - | </ | + | </openXML> |
Current revision as of 06:28, 16 June 2016
Contents |
Module Customer > Delete
| Module | customer |
| Command name | deleteCustomerRequest |
| Use | Deletes an existing customer object; will only succeed if no domains (or other objects) are linked to this customer handle |
| Input | |
| Output |
- |
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('deleteCustomerRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'handle' => 'AJ001927-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>
<deleteCustomerRequest>
<handle>JH000001-US</handle>
</deleteCustomerRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
< code>0</code>
<desc></desc>
<data>1</data>
</reply>
</openXML>