API Module Tag createTagRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 10:14, 8 June 2016

Module Tag > Create

Module	Tag
Command name	createTagRequest
Use	Creates a tag on top of customer handle. That allows to categorize or group customers. Such grouping could be used in customization of ICANN emails look and feel, e.g. in case when reseller has several brands and would like ICANN emails to be sent with different layout and headers to different customers in his portfolio
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>

@@ Line 9: / Line 9: @@
 |-
 |'''Use'''
-|Creates a tag
+|Creates a tag on top of customer handle. That allows to categorize or group customers. Such grouping could be used in customization of ICANN emails look and feel, e.g. in case when reseller has several brands and would like ICANN emails to be sent with different layout and headers to different customers in his portfolio
 |- style="vertical-align:top;"
 |'''Input'''