API Module Domain modifyDomainRequest

From Openprovider API documentation

Contents 1 Module Domain > Modify 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Domain > Modify

Module	domain
Command name	modifyDomainRequest
Use	Used to modify the attributes of the domain existing in reseller account
Input	domain ownerHandle (customer unique identifier or handle) adminHandle (customer unique identifier or handle) techHandle (customer unique identifier or handle) billingHandle (customer unique identifier or handle) resellerHandle (customer unique identifier or handle) nsGroup nsTemplateName nameServers isDnssecEnabled (0 (default) or 1 - Only accepted when nameservers of Openprovider are used) useDomicile (0 (default) or 1) isPrivateWhoisEnabled (0 or 1, default value is 0) isLocked (0 or 1, default value is 0) autorenew ( on | off | default ) dnssecKeys scheduledAt (only accepted by domains in status 'SCH')
Output	-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('modifyDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'adminHandle' => 'SR003891-NL',
    'techHandle' => 'SR003891-NL',
    'billingHandle' => 'SR003891-NL',
    'domain' => array(
      'name' => 'openprovider',
      'extension' => 'nl'
    ),
    'nsGroup' => 'MyServer',
    'isDnssecEnabled' => 1,
    'dnssecKeys' => array(
      array(
        'flags' => 256,
        'alg' => 8,
        'protocol' => 3,
        'pubKey' => 'AwEAA{...}VNfPps3=',
      ),
      array(
        'flags' => 257,
        'alg' => 8,
        'protocol' => 3,
        'pubKey' => 'AwEAA{...}TK5f9fs=',
      ),
    ),
  ));

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>
  <modifyDomainRequest>
    <adminHandle>SR003891-NL</adminHandle>
    <techHandle>SR003891-NL</techHandle>
    <billingHandle>SR003891-NL</billingHandle>
    <domain>
      <name>openprovider</name>
      <extension>nl</extension>
    </domain>
    <nsGroup>MyServer</nsGroup>
    <isDnssecEnabled>1</isDnssecEnabled>
    <dnssecKeys>
      <array>
        <item>
          <flags>256</flags>
          <alg>8</alg>
          <protocol>3</protocol>
          <pubKey>AwEAA{...}VNfPps3=</pubKey>
        </item>
        <item>
          <flags>257</flags>
          <alg>8</alg>
          <protocol>3</protocol>
          <pubKey>AwEAA{...}TK5f9fs=</pubKey>
        </item>
      </array>
    </dnssecKeys>
  </modifyDomainRequest>
</openXML>

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