API Module Tag createTagRequest

From Openprovider API documentation

Revision as of 11:55, 12 October 2015 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 12:04, 12 October 2015 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 13:		Line 13:
	|'''Input'''		|'''Input'''
	|		|
-	*key	+	*key ['customer']
-	*value ['customer']	+	*value
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''

---

Revision as of 12:04, 12 October 2015

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

Module Tag > Create

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

Examples

Using PHP class

$request = new OP_Request; 
$request->setCommand('createTagRequest')
   ->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>
  <createTagRequest>
    <key>customer</key>
    <value>companyA</value>
  </createTagRequest>
</openXML>

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