API Module Domain requestAuthCodeDomainRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 09:01, 21 January 2021

Module Domain > Request Authorization Code

Module	domain
Command name	requestAuthCodeDomainRequest
Use	Reads the transfer authorization code (or EPP code) from the registry or triggers the registry to send a code to the domain owner (like in case of e.g. .be and .eu). If the registry does not support the retrieval of an authorization code (e.g. .se and .nu), please refer to the resetAuthCodeDomainRequest command.
Input	domain authCodeType
Output	-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('requestAuthCodeDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domain' => array(
      'name' => 'domain',
      'extension' => 'be'
    ),
    'authCodeType' => 'external',
  ));

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>
  <requestAuthCodeDomainRequest>
    <domain>
      <name>domain</name>
      <extension>be</extension>
    </domain>
    <authCodeType>external</authCodeType>
  </requestAuthCodeDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    </desc>
    <data>
     <authCode>3fdchdHKsHA4Ke</authCode>
     <type>external</type>
    </data>
  </reply>
</openXML>

@@ Line 9: / Line 9: @@
 |-
 |'''Use'''
-|Reads the authorization code from the registry, or let the registry send the code to the domain owner (in case the registry sends the code not to the registrar but only to the registrant, like DNS BE and EURid)
+|Reads the transfer authorization code (or EPP code) from the registry or triggers the registry to send a code to the domain owner (like in case of e.g. .be and .eu). If the registry does not support the retrieval of an authorization code (e.g. .se and .nu), please refer to the [[API Module Domain resetAuthCodeDomainRequest|resetAuthCodeDomainRequest]] command.
 |- style="vertical-align:top;"
 |'''Input'''
 |
 *'''[[API Format Domain|domain]]'''
-*authCodeType ''(external [default] or internal)''
+*[[API Format authCodeType|authCodeType]]
 |- style="vertical-align:top;"
 |'''Output'''
@@ Line 55: / Line 55: @@
     <reply>
       <nowiki><code>0</code></nowiki>
-      <desc></desc>
+      </desc>
+     <data>
+      <authCode>3fdchdHKsHA4Ke</authCode>
+      <type>external</type>
+     </data>
     </reply>
   </openXML>