API Module Customer deleteCustomerRequest

From Openprovider API documentation

Revision as of 08:37, 16 April 2010 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 13:36, 1 July 2010 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 31:		Line 31:
	===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>
-	<deletecustomerrequest>	+	<deleteCustomerRequest>
	<handle>JH000001-US</handle>		<handle>JH000001-US</handle>
-	</deletecustomerrequest>	+	</deleteCustomerRequest>
-	</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>
Line 48:		Line 48:
	<data>1</data>		<data>1</data>
	</reply>		</reply>
-	</openxml>	+	</openXML>

---

Revision as of 13:36, 1 July 2010

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

Module Customer > Delete

Module	customer
Command name	deleteCustomerRequest
Use	Deletes an existing customer object; will only succeed if no domains are linked to this customer
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

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