API Module Reseller retrieveResellerRequest

From Openprovider API documentation

Revision as of 08:59, 9 November 2010 (view source) WikiSysop (Talk | contribs) (Created page with '==Module Reseller > Retrieve== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |reseller |- style="background-color:#EEEEEE;" |'''Command name'''…') ← Older edit		Current revision as of 11:46, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Reseller > Retrieve)
(4 intermediate revisions not shown)
Line 13:		Line 13:
	|'''Input'''		|'''Input'''
	|		|
-	*withAdditionalData ''default value: 0''	+	-
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''
Line 19:		Line 19:
	*id		*id
	*companyName		*companyName
-	*balance
-	*vat
	*[[API Format Address|address]]		*[[API Format Address|address]]
	*[[API Format Phone|phone]]		*[[API Format Phone|phone]]
	*[[API Format Phone|fax]]		*[[API Format Phone|fax]]
-	*[[API Format Additional Data Customer|additionalData]] (if withAdditionalData = 1)	+	*vatperc (VAT percentage that applied for reseller)
		+	*balance (availableBalance + reservedBalance)
		+	*reservedBalance (reserved amount for pending operations)
	|}		|}
Line 36:		Line 36:
	===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 48:		Line 49:
	<openXML>		<openXML>
	<reply>		<reply>
-	< code>0</code>	+	<nowiki><code>0</code></nowiki>
	<desc />		<desc />
	<data>		<data>

---

Current revision as of 11:46, 17 June 2016

Contents 1 Module Reseller > Retrieve 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Reseller > Retrieve

Module	reseller
Command name	retrieveResellerRequest
Use	Retrieves information about your reseller account
Input	-
Output	id companyName address phone fax vatperc (VAT percentage that applied for reseller) balance (availableBalance + reservedBalance) reservedBalance (reserved amount for pending operations)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveResellerRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
));

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>
  <retrieveResellerRequest />
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc />
    <data>
      <id>16342915</id>
      <companyName>Openprovider</companyName>
      <vat>NL809507882B01</vat>
      <phone>
        <countryCode>+31</countryCode>
        <areaCode>10</areaCode>
        <subscriberNumber>4482299</subscriberNumber>
      </phone>
      <address>
        <street>Nieuwe Binnenweg</street>
        <number>137</number>
        <zipcode>3014 GJ</zipcode>
        <city>Rotterdam</city>
        <country>NL</country>
        <state>Zuid-Holland</state>
      </address>
      <balance>263.94</balance>
    </data>
  </reply>
</openXML>