API Module Customer retrieveCustomerRequest

From Openprovider API documentation

Revision as of 06:23, 16 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Customer > Retrieve) ← Older edit		Revision as of 07:27, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Customer > Retrieve) Newer edit →
Line 20:		Line 20:
	*[[API Format Handle|handle]]		*[[API Format Handle|handle]]
	*companyName		*companyName
-	*vat	+	*[[API Format vat|vat]]
	*[[API Format Name|name]]		*[[API Format Name|name]]
	*[[API Format Gender|gender]]		*[[API Format Gender|gender]]

---

Revision as of 07:27, 17 June 2016

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

Module Customer > Retrieve

Module	customer
Command name	retrieveCustomerRequest
Use	Retrieves information of an existing customer object
Input	handle withAdditionalData
Output	handle companyName vat name gender address phone fax email emailVerificationStatus additionalData (if withAdditionalData = true) extensionAdditionalData (if withAdditionalData = true)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveCustomerRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
   'handle' => 'AJ001927-NL'
 ));

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>
  <retrieveCustomerRequest>
    <handle>JH000001-US</handle>
    <withadditionalData>0</withadditionalData>
  </retrieveCustomerRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <companyName>Hosting Unlimited</companyName>
      <name>
        <initials>J.B.</initials>
        <firstName>John</firstName>
        <prefix>van</prefix>
        <lastName>Halen</lastName>
      </name>
      <gender>M</gender>
      <phone>
        <countryCode>+8</countryCode>
        <areaCode>383</areaCode>
        <subscriberNumber>1231212</subscriberNumber>
      </phone>
      <fax>
        <countryCode>+8</countryCode>
        <areaCode>383</areaCode>
        <subscriberNumber>1231213</subscriberNumber>
      </fax>
      <address>
        <street>Main Street</street>
        <number>2</number>
        <zipcode>630060</zipcode>
        <city>Washington</city>
        <country>US</country>
        <suffix>a</suffix>
      </address>
      <email>info@openprovider.nl</email>
      <handle>JH000001-US</handle>
      <comments></comments>
    </data>
  </reply>
</openXML>