API Module Domain retrieveAdditionalDataDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Raw XML) |
(→Module Domain > Retrieve Additional Data) |
||
| Line 19: | Line 19: | ||
*name (field name) | *name (field name) | ||
*required (if the field is required to register domain) | *required (if the field is required to register domain) | ||
| - | *type (field type, e.g. | + | *type (field type, e.g. text, check, select, multiselect) |
*[[API Format options|options]] (possible values & value descriptions) | *[[API Format options|options]] (possible values & value descriptions) | ||
*description | *description | ||
Revision as of 15:18, 17 June 2016
Contents |
Module Domain > Retrieve Additional Data
| Module | domain (only extension in [name,extension] array is mandatory) |
| Command name | retrieveAdditionalDataDomainRequest |
| Use | Retrieve additional data & fields required to register domain in specific TLD |
| Input | |
| Output | Overview of extension details:
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('retrieveAdditionalDataDomainRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'domain' => array(
'extension' => 'us'
),
));
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>
<retrieveAdditionalDataDomainRequest>
<domain>
<extension>us</extension>
</domain>
</retrieveAdditionalDataDomainRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
<code>0</code>
<desc></desc>
<data>
<array>
<item>
<name>nexusAppPurpose</name>
<required>1</required>
<type>select</type>
<options>
<array>
<item>
<value>P1</value>
<description>Business use for profit</description>
</item>
<item>
<value>P2</value>
<description>Non-profit business, club, association, religious organization, etc.</description>
</item>
<item>
<value>P3</value>
<description>Personal use</description>
</item>
<item>
<value>P4</value>
<description>Education purposes</description>
</item>
<item>
<value>P5</value>
<description>Government purposes</description>
</item>
</array>
</options>
<description>Enter one of the following purposes</description>
</item>
</array>
</data>
</reply>
</openXML>