API Module Tag searchTagRequest

From Openprovider API documentation

Revision as of 12:30, 12 October 2015 (view source) WikiSysop (Talk | contribs) (Created page with '==Module Tag > Search == {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Tag |- style="background-color:#EEEEEE;" |'''Command name''' |searchTag…') ← Older edit		Revision as of 12:30, 12 October 2015 (view source) WikiSysop (Talk | contribs) (→Using PHP class) Newer edit →
Line 28:		Line 28:
	->setArgs([		->setArgs([
	'key' => 'customer',		'key' => 'customer',
-	'value' => 'value',	+	'value' => 'customerA',
	]);		]);

---

Revision as of 12:30, 12 October 2015

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

Module Tag > Search

Module	Tag
Command name	searchTagRequest
Use	Searches a tag by value
Input	key ['customer'] value
Output	array of tags

Examples

Using PHP class

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

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

<?xml version="1.0" encoding="UTF-8"?>

<openXML>
<reply>
  0
  <desc></desc>
  <data>
   <results>
    <array>
     <item><key>customer</key><value>companyA</value></item>
    </array>
   </results>
   <total>1</total>
  </data>
 </reply>
</openXML>