API Module Customer deleteCustomerRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 06:28, 16 June 2016

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

@@ Line 9: / Line 9: @@
 |-
 |'''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;"
 |'''Input'''