API Module Domain requestAuthCodeDomainRequest

From Openprovider API documentation

Revision as of 12:48, 17 June 2011 (view source) WikiSysop (Talk | contribs) (Created page with '==Module Domain > Request Authorization Code== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |domain |- style="background-color:#EEEEEE;" |'''C…') ← Older edit		Current revision as of 09:01, 21 January 2021 (view source) WikiSysop (Talk | contribs)
(9 intermediate revisions not shown)
Line 9:		Line 9:
	|-		|-
	|'''Use'''		|'''Use'''
-	|Currently only available for .be domains. Will request DNS BE to send the authorization code for a domain to the domain owner.	+	|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;"		|- style="vertical-align:top;"
	|'''Input'''		|'''Input'''
	|		|
	*'''[[API Format Domain|domain]]'''		*'''[[API Format Domain|domain]]'''
		+	*[[API Format authCodeType|authCodeType]]
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''
Line 30:		Line 31:
	'extension' => 'be'		'extension' => 'be'
	),		),
		+	'authCodeType' => 'external',
	));		));
	===Raw XML===		===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"?>		<?xml version="1.0" encoding="UTF-8"?>
	<openXML>		<openXML>
Line 44:		Line 47:
	<extension>be</extension>		<extension>be</extension>
	</domain>		</domain>
		+	<authCodeType>external</authCodeType>
	</requestAuthCodeDomainRequest>		</requestAuthCodeDomainRequest>
	</openXML>		</openXML>
Line 50:		Line 54:
	<openXML>		<openXML>
	<reply>		<reply>
-	< code>0</code>	+	<nowiki><code>0</code></nowiki>
-	<desc></desc>	+	</desc>
		+	<data>
		+	<authCode>3fdchdHKsHA4Ke</authCode>
		+	<type>external</type>
		+	</data>
	</reply>		</reply>
	</openXML>		</openXML>

---

Current revision as of 09:01, 21 January 2021

Contents 1 Module Domain > Request Authorization Code 2 Examples 2.1 Using PHP class 2.2 Raw XML

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>