API Module Tag searchTagRequest
From Openprovider API documentation
(Difference between revisions)
(→Raw XML) |
|||
Line 50: | Line 50: | ||
<openXML> | <openXML> | ||
<reply> | <reply> | ||
- | <code>0</code> | + | <nowiki><code>0</code></nowiki> |
<desc></desc> | <desc></desc> | ||
<data> | <data> |
Current revision as of 12:42, 17 June 2016
Contents |
Module Tag > Search
Module | Tag |
Command name | searchTagRequest |
Use | Searches a tag by value |
Input |
|
Output |
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> <code>0</code> <desc></desc> <data> <results> <array> <item><key>customer</key><value>companyA</value></item> </array> </results> <total>1</total> </data> </reply> </openXML>