API Module Domain retrieveAdditionalDataDomainRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 08:43, 30 November 2016

Module Domain > Retrieve Additional Data

Module	domain
Command name	retrieveAdditionalDataDomainRequest
Use	Retrieve additional data & fields required to register domain in specific TLD
Input	domain (only extension in [name,extension] array is mandatory)
Output	Overview of extension details: name (field name) required (if the field is mandatory or optional) type (field type, e.g. text, check, select, multiselect) options (possible values & value descriptions) description

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveAdditionalDataDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domain' => array(
      'extension' => 'ca'
    ),
  ));

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>ca</extension>
    </domain>
  </retrieveAdditionalDataDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>
      <array>
        <item>
          <name>legalType</name>
          <description>Legal type</description>
          <required>1</required>
          <type>select</type>
          <options>
            <array>
              <item>
                <value>ABO</value>
                <description>Aboriginal Peoples indigenous to Canada</description>
              </item>
              <item>
                <value>ASS</value>
                <description>Canadian Unincorporated Association</description>
              </item>
              ...
              <item>
                <value>TRS</value>
                <description>Trust established in Canada</description>
              </item>
            </array>
          </options>
        </item>
      </array>
    </data>
  </reply>
</openXML>