API Module Domain retrieveDomainRequest
From Openprovider API documentation
(Difference between revisions)
| (14 intermediate revisions not shown) | |||
| Line 16: | Line 16: | ||
*withAdditionalData | *withAdditionalData | ||
*withRegistryDetails | *withRegistryDetails | ||
| + | *withAbuseDetails (''default value: 0'') | ||
| + | *withWhoisPrivacyData | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
| Line 23: | Line 25: | ||
*activeDate | *activeDate | ||
*expirationDate | *expirationDate | ||
| - | *expirationDateOpenprovider | + | *expirationDateOpenprovider - Same as renewalDate. |
| - | *ownerHandle | + | *renewalDate - Date when a domain expires at Openprovider. This date should be referred for domain expiration and renewals. |
| - | *adminHandle | + | *[[API Format Handle|ownerHandle]] |
| - | *techHandle | + | *[[API Format Handle|adminHandle]] |
| - | *billingHandle | + | *[[API Format Handle|techHandle]] |
| - | *resellerHandle | + | *[[API Format Handle|billingHandle]] |
| - | *nsGroup | + | *[[API Format Handle|resellerHandle]] |
| + | *[[API Format nsGroup|nsGroup]] | ||
*[[API Format Nameservers|nameServers]] | *[[API Format Nameservers|nameServers]] | ||
| - | *authCode | + | *[[API Format authCode|authCode]] |
| - | *status | + | *[[API Format Domain Status|status]] |
| - | * | + | *[[API Format autorenew|autorenew]] |
| - | * | + | *[[API Format isLocked|isLocked]] |
| - | + | *[[API Format useDomicile|useDomicile]] | |
| - | *useDomicile | + | *[[API Format Transfer At|at]] |
| - | *at | + | *[[API Format Additional Data|additionalData]] (if withAdditionalData = true) |
| - | *[[API Format Additional Data | + | *[[API Format Whois Privacy Data|whoisPrivacyData]] (if withWhoisPrivacyData = true) |
*registryDetails (if withRegistryDetails = true) | *registryDetails (if withRegistryDetails = true) | ||
| - | * | + | *abuseDetails (if withAbuseDetails = true) |
| - | *hardQuarantineExpiryDate | + | *softQuarantineExpiryDate (if status=DEL or RRQ) |
| - | *restorableUntil | + | *hardQuarantineExpiryDate (if status=DEL or RRQ) |
| + | *restorableUntil (if status=DEL or RRQ) | ||
|} | |} | ||
Current revision as of 10:55, 12 November 2025
Contents |
Module Domain > Retrieve
| Module | domain |
| Command name | retrieveDomainRequest |
| Use | Retrieves information about an existing domain object |
| Input |
|
| Output |
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('retrieveDomainRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'domain' => array(
'name' => 'openprovider',
'extension' => 'nl'
),
'withAdditionalData' => 0
));
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>
<retrieveDomainRequest>
<domain>
<name>domain-info</name>
<extension>nl</extension>
</domain>
<withadditionalData>0</withadditionalData>
</retrieveDomainRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
0
<desc></desc>
<data>
<domain>
<name>abcdefg4</name>
<extension>nl</extension>
</domain>
<nameServers />
<id>341105</id>
<isLockable>0</isLockable>
<isLocked>0</isLocked>
<comments></comments>
<orderDate>2010-03-15 16:50:19</orderDate>
<activeDate />
<expirationDate></expirationDate>
<expirationDateOpenprovider></expirationDateOpenprovider>
<status>FAI</status>
<canRenew>0</canRenew>
<autoRenew>0</autoRenew>
<ownerHandle>OH002766-NL</ownerHandle>
<adminHandle>OH002766-NL</adminHandle>
<techHandle>OH002766-NL</techHandle>
<billingHandle>SR003891-NL</billingHandle>
<nsGroup>opdrs4</nsGroup>
<type>NEW</type>
<authCode></authCode>
<authorizationCodeRequired>0</authorizationCodeRequired>
<tradeAllowed>1</tradeAllowed>
<restorePrice>70</restorePrice>
<useDomicile>0</useDomicile>
<ownerName>
<initials>N.</initials>
<firstName>Nigel</firstName>
<prefix />
<lastName>Jones</lastName>
</ownerName>
<ownerCompanyName></ownerCompanyName>
</data>
</reply>
</openXML>