API Module Domain retrievePriceDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 12:43, 30 July 2015

Module Domain > Retrieve Domain Price

Module	domain
Command name	retrievePriceDomainRequest
Use	Retrieves domain price that applies for the reseller
Input	domain operation (create[default] \| transfer \| renew \| restore \| update )
Output	price isPremium

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrievePriceDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domain' => array(
      'name' => 'domain',
      'extension' => 'guru'
    ),
    'operation' => 'create',
  ));

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>
  <retrievePriceDomainRequest>
    <domain>
      <name>domain</name>
      <extension>guru</extension>
    </domain>
    <operation>create</operation>
  </retrievePriceDomainRequest>
</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)''
+*operation ''(create[default] | transfer | renew | restore | update )''
 |- style="vertical-align:top;"
 |'''Output'''
 |
--
+*[[API Format Price|price]]
+*isPremium
 |}