API Module Domain renewDomainRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 08:47, 16 June 2016

Module Domain > Renew

Module	domain
Command name	renewDomainRequest
Use	Used to renew domain name in reseller account for specified period.
Input	domain period
Output	-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('renewDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domain' => array(
      'name' => 'openprovider',
      'extension' => 'nl'
    ),
    'period' => 1
  ));

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</password>
  </credentials>
  <renewDomainRequest>
    <domain>
      <name>openprovider</name>
      <extension>nl</extension>
    </domain>
    <period>1</period>
  </renewDomainRequest>
</openXML>

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

@@ Line 9: / Line 9: @@
 |-
 |'''Use'''
-|Renews a registered domain name.
+|Used to renew domain name in reseller account for specified period.
 |- style="vertical-align:top;"
 |'''Input'''
 |
 *'''[[API Format Domain|domain]]'''
-*'''period'''
+*'''[[API Format Period|period]]'''
 |- style="vertical-align:top;"
 |'''Output'''
@@ Line 35: / Line 35: @@
 ===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>