API Module Domain requestAuthCodeDomainRequest

From Openprovider API documentation

Revision as of 11:10, 23 March 2012 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 06:22, 27 June 2012 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 14:		Line 14:
	|		|
	*'''[[API Format Domain|domain]]'''		*'''[[API Format Domain|domain]]'''
		+	*authCodeType ''(external [default] or internal)''
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''
Line 30:		Line 31:
	'extension' => 'be'		'extension' => 'be'
	),		),
		+	'authCodeType' => 'external',
	));		));
Line 45:		Line 47:
	<extension>be</extension>		<extension>be</extension>
	</domain>		</domain>
		+	<authCodeType>external</authCodeType>
	</requestAuthCodeDomainRequest>		</requestAuthCodeDomainRequest>
	</openXML>		</openXML>

---

Revision as of 06:22, 27 June 2012

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	Currently only available for .be domains. Will request DNS BE to send the authorization code for a domain to the domain owner.
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>