API Module Domain retrieveAdditionalDataDomainRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Raw XML)
(→Raw XML)
 
(5 intermediate revisions not shown)
Line 3: Line 3:
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
|'''Module'''
|'''Module'''
-
|domain (only extension in [name,extension] array is mandatory)
+
|domain
|- style="background-color:#EEEEEE;"
|- style="background-color:#EEEEEE;"
|'''Command name'''
|'''Command name'''
Line 13: Line 13:
|'''Input'''
|'''Input'''
|
|
-
*'''[[API Format Domain|domain]]'''
+
*'''[[API Format Domain|domain]]''' (only extension in [name,extension] array is mandatory)
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
|Overview of extension details:
|Overview of extension details:
*name (field name)
*name (field name)
-
*required (if the field is required to register domain)
+
*required (if the field is mandatory or optional)
-
*type (field type, e.g. select, input, bool etc.)
+
*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
Line 31: Line 31:
   ->setArgs(array(
   ->setArgs(array(
     'domain' => array(
     'domain' => array(
-
       'extension' => 'us'
+
       'extension' => 'ca'
     ),
     ),
   ));
   ));
Line 45: Line 45:
   <retrieveAdditionalDataDomainRequest>
   <retrieveAdditionalDataDomainRequest>
     <domain>
     <domain>
-
       <extension>us</extension>
+
       <extension>ca</extension>
     </domain>
     </domain>
   </retrieveAdditionalDataDomainRequest>
   </retrieveAdditionalDataDomainRequest>
Line 58: Line 58:
       <array>
       <array>
         <item>
         <item>
-
           <name>nexusAppPurpose</name>
+
           <name>legalType</name>
 +
          <description>Legal type</description>
           <required>1</required>
           <required>1</required>
           <type>select</type>
           <type>select</type>
Line 64: Line 65:
             <array>
             <array>
               <item>
               <item>
-
                 <value>P1</value>
+
                 <value>ABO</value>
-
                 <description>Business use for profit</description>
+
                 <description>Aboriginal Peoples indigenous to Canada</description>
               </item>
               </item>
               <item>
               <item>
-
                 <value>P2</value>
+
                 <value>ASS</value>
-
                 <description>Non-profit business, club, association, religious organization, etc.</description>
+
                 <description>Canadian Unincorporated Association</description>
               </item>
               </item>
 +
              ...
               <item>
               <item>
-
                 <value>P3</value>
+
                 <value>TRS</value>
-
                 <description>Personal use</description>
+
                 <description>Trust established in Canada</description>
-
              </item>
+
-
              <item>
+
-
                <value>P4</value>
+
-
                <description>Education purposes</description>
+
-
              </item>
+
-
              <item>
+
-
                <value>P5</value>
+
-
                <description>Government purposes</description>
+
               </item>
               </item>
             </array>
             </array>
           </options>
           </options>
-
          <description>Enter one of the following purposes</description>
 
         </item>
         </item>
       </array>
       </array>

Current revision as of 08:43, 30 November 2016

Contents

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>
Retrieved from "https://doc.openprovider.eu/API_Module_Domain_retrieveAdditionalDataDomainRequest"
Views
Personal tools