API Module Tag deleteTagRequest

From Openprovider API documentation

Revision as of 12:03, 12 October 2015 (view source) WikiSysop (Talk | contribs) (Created page with '==Module Tag > Delete== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Tag |- style="background-color:#EEEEEE;" |'''Command name''' |DeleteTagR…') ← Older edit		Current revision as of 12:42, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Raw XML)
Line 49:		Line 49:
	<openXML>		<openXML>
	<reply>		<reply>
-	<code>0</code>	+	<nowiki><code>0</code></nowiki>
	<desc></desc>		<desc></desc>
	<data>1</data>		<data>1</data>
	</reply>		</reply>
	</openXML>		</openXML>

---

Current revision as of 12:42, 17 June 2016

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

Module Tag > Delete

Module	Tag
Command name	DeleteTagRequest
Use	Deletes a tag
Input	key ['customer'] value
Output	true

Examples

Using PHP class

$request = new OP_Request; 
$request->setCommand('deleteTagRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs([
       'key' => 'customer',
       'value' => 'value',
   ]);

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>
  </credentials>
  <deleteTagRequest>
    <key>customer</key>
    <value>companyA</value>
  </deleteTagRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>1</data>
  </reply>
</openXML>