API Module Domain requestAuthCodeDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 06:48, 17 June 2016

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)
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></desc>
  </reply>
</openXML>

@@ Line 14: / Line 14: @@
 |
 *'''[[API Format Domain|domain]]'''
-*authCodeType ''(external [default] or internal)''
+*[[API Format authCodeType|authCodeType]]
 |- style="vertical-align:top;"
 |'''Output'''