API Module Domain transferDomainRequest
From Openprovider API documentation
(Difference between revisions)
| Line 22: | Line 22: | ||
*[[API Format Handle|resellerHandle]] | *[[API Format Handle|resellerHandle]] | ||
*'''[[API Format nsGroup|nsGroup]]''' ('nameserver group', use ''dns-openprovider'' if you want to use our nameservers. Mandatory field only if nameServers field is empty) | *'''[[API Format nsGroup|nsGroup]]''' ('nameserver group', use ''dns-openprovider'' if you want to use our nameservers. Mandatory field only if nameServers field is empty) | ||
| - | *[[API Format nsTemplateName|nsTemplateName]] (name of the template to use to automatically create DNS zone on the domain) | + | *[[API Format nsTemplateName|nsTemplateName]] (name of the template to use to automatically create DNS zone on the domain; only applicable if nsGroup is ''dns-openprovider'') |
*'''[[API Format Nameservers|nameServers]]''' (mandatory field only if nsGroup field is empty) | *'''[[API Format Nameservers|nameServers]]''' (mandatory field only if nsGroup field is empty) | ||
*[[API Format autorenew|autorenew]] ''( on | off | default )'' | *[[API Format autorenew|autorenew]] ''( on | off | default )'' | ||
Revision as of 10:04, 31 August 2017
Contents |
Module Domain > Transfer
| Module | domain |
| Command name | transferDomainRequest |
| Use | Used to start or schedule domain transfer |
| Input |
|
| Output |
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('transferDomainRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'ownerHandle' => 'SR003891-NL',
'adminHandle' => 'SR003891-NL',
'techHandle' => 'SR003891-NL',
'billingHandle' => 'SR003891-NL',
'domain' => array(
'name' => 'domain',
'extension' => 'com'
),
'period' => '1',
'authCode' => 'asd79SAD(8sd',
'nameServers' => array(
array(
'name' => 'ns1.yourdomain.com',
'ip' => '100.1.2.3',
'ip6' => '2a01:d078:0:147:94:198:153:68',
),
array(
'name' => 'ns2.yourdomain.com',
'ip' => '100.1.2.6',
'ip6' => '20f1:610:0:800d::15',
),
),
'dnssecKeys' => array(
array(
'flags' => 256,
'alg' => 8,
'pubKey' => 'AwEAA{...}VNfPps3=',
),
array(
'flags' => 257,
'alg' => 8,
'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>
<transferDomainRequest>
<ownerHandle>SR003891-NL</ownerHandle>
<adminHandle>SR003891-NL</adminHandle>
<techHandle>SR003891-NL</techHandle>
<billingHandle>SR003891-NL</billingHandle>
<domain>
<name>this-domain-is-registered</name>
<extension>com</extension>
</domain>
<period>1</period>
<authCode>asd79SAD(8sd</authCode>
<nameServers>
<array>
<item>
<name>ns1.yourdomain.com</name>
<ip>100.1.2.3</ip>
<ip6>2a01:d078:0:147:94:198:153:68</ip6>
</item>
<item>
<name>ns2.yourdomain.com</name>
<ip>100.1.2.6</ip>
<ip6>20f1:610:0:800d::15</ip6>
</item>
</array>
</nameServers>
<dnssecKeys>
<array>
<item>
<flags>256</flags>
<alg>8</alg>
<pubKey>AwEAA{...}VNfPps3=</pubKey>
</item>
<item>
<flags>257</flags>
<alg>8</alg>
<pubKey>AwEAA{...}TK5f9fs=</pubKey>
</item>
</array>
</dnssecKeys>
</transferDomainRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
<code>0</code>
<desc></desc>
</reply>
</openXML>