API Module Tag createTagRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Tag > Create== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Tag |- style="background-color:#EEEEEE;" |'''Command name''' |createTagR…')
(Raw XML)
Line 33: Line 33:
===Raw XML===
===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.''
''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>
 +
    <code>0</code>
 +
    <desc></desc>
 +
    <data>1</data>
 +
  </reply>
 +
</openXML>

Revision as of 11:52, 12 October 2015

Contents

Module Tag > Create

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

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>
Views
Personal tools