API Module Domain requestAuthCodeDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 06:46, 17 June 2016

Module Domain > Request Authorization Code

Module	domain
Command name	requestAuthCodeDomainRequest
Use	Reads the transfer authorization code from the registry, or let the registry send the code to the domain owner (in case the registry sends the code only to the registrant, like in case of .be or .eu)
Input	domain authCodeType (external [default] or internal)
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></desc>
  </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 from the registry, or let the registry send the code to the domain owner (in case the registry sends the code only to the registrant, like in case of .be or .eu)
 |- style="vertical-align:top;"
 |'''Input'''