API Module Domain tradeDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Trade) |
|||
| (9 intermediate revisions not shown) | |||
| Line 14: | Line 14: | ||
| | | | ||
*'''[[API Format Domain|domain]]''' | *'''[[API Format Domain|domain]]''' | ||
| - | * | + | *[[API Format Period|period]] |
*'''[[API Format Handle|ownerHandle]]''' (customer unique identifier or [[API Format Handle|handle]]) | *'''[[API Format Handle|ownerHandle]]''' (customer unique identifier or [[API Format Handle|handle]]) | ||
*'''[[API Format Handle|adminHandle]]''' (customer unique identifier or [[API Format Handle|handle]]) | *'''[[API Format Handle|adminHandle]]''' (customer unique identifier or [[API Format Handle|handle]]) | ||
| Line 21: | Line 21: | ||
*[[API Format Handle|resellerHandle]] (customer unique identifier or [[API Format Handle|handle]]) | *[[API Format Handle|resellerHandle]] (customer unique identifier or [[API Format Handle|handle]]) | ||
*[[API Format authCode|authCode]] | *[[API Format authCode|authCode]] | ||
| - | *'''[[API Format | + | *'''[[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 | + | *[[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) | ||
| - | *isDnssecEnabled (''0'' (default) or ''1'' - Only | + | *[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used) |
| - | *useDomicile | + | *[[API Format DNSSEC Keys|dnssecKeys]] (when using your own nameservers) |
| + | *[[API Format useDomicile|useDomicile]] (''0'' or ''1'', default value is ''0'') | ||
| + | *[[API Format autorenew|autorenew]] ''( on | off | default )'' | ||
*promoCode | *promoCode | ||
| - | |||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
| Line 33: | Line 34: | ||
*status ''(ACT - active or REQ - requested)'' | *status ''(ACT - active or REQ - requested)'' | ||
*[[API Format expirationDate|expirationDate]] ''(available only in case of a succeeded realtime domain trade)'' | *[[API Format expirationDate|expirationDate]] ''(available only in case of a succeeded realtime domain trade)'' | ||
| - | *[[API Format expirationDateOpenprovider|expirationDateOpenprovider]] ''( | + | *[[API Format expirationDateOpenprovider|expirationDateOpenprovider]] ''(Same as renewalDate. Available only in case of a succeeded realtime domain trade)'' |
| + | *[[API Format renewalDate|renewalDate]] ''(Date when a domain expires at Openprovider. This date should be referred for domain expiration and renewals. Available only in case of a succeeded realtime domain trade)'' | ||
|} | |} | ||
Current revision as of 09:11, 19 August 2025
Contents |
Module Domain > Trade
| Module | domain |
| Command name | tradeDomainRequest |
| Use | Changes the owner of an existing domain |
| Input |
|
| Output |
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('tradeDomainRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'ownerHandle' => 'SR003891-NL',
'adminHandle' => 'SR003891-NL',
'techHandle' => 'SR003891-NL',
'billingHandle' => 'SR003891-NL',
'domain' => array(
'name' => 'openprovider',
'extension' => 'nl'
),
'nsGroup' => 'MyServer',
));
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>
<tradeDomainRequest>
<ownerHandle>SR003891-NL</ownerHandle>
<adminHandle>SR003891-NL</adminHandle>
<techHandle>SR003891-NL</techHandle>
<billingHandle>SR003891-NL</billingHandle>
<domain>
<name>openprovider</name>
<extension>nl</extension>
</domain>
<nsGroup>MyServer</nsGroup>
</tradeDomainRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
< code>364</code>
<desc>Owner handle must differ from the current one.</desc>
<data />
</reply>
</openXML>