API Module Reseller retrieveResellerRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 13:58, 1 May 2012

Module Reseller > Retrieve

Module	reseller
Command name	retrieveResellerRequest
Use	Retrieves information about your reseller account
Input	-
Output	id companyName address phone fax vatperc balance reservedBalance available balance is balance - reservedBalance

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>

@@ Line 19: / Line 19: @@
 *id
 *companyName
-*balance
-*vat
 *[[API Format Address|address]]
 *[[API Format Phone|phone]]
 *[[API Format Phone|fax]]
+*vatperc
+*balance
+*reservedBalance
+''available balance'' is ''balance - reservedBalance''
 |}