API Module Domain retrieveAdditionalDataDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 15:02, 17 June 2016

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	domain
Output	Overview of extension details: name (field name) required (if the field is required to register domain) type (field type, e.g. select, input, bool etc.) options (possible values & value descriptions)

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>

@@ Line 17: / Line 17: @@
 |'''Output'''
 |Overview of extension details:
-*name
+*name (field name)
 *required (if the field is required to register domain)
 *type (field type, e.g. select, input, bool etc.)