API Module Customer retrieveCustomerRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 08:03, 18 May 2016

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>

@@ Line 29: / Line 29: @@
 *[[API Format EmailVerificationStatus|emailVerificationStatus]]
 *[[API Format Additional Data Customer|additionalData]] (if withAdditionalData = true)
-*[[API Format Additional Extension Data Customer|extensionAdditionalData]] (if withAdditionalData = true)
+*[[API_Format_Extensions_Additional_Data_Customer|extensionAdditionalData]] (if withAdditionalData = true)
 |}