This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

Go to the new documentation

API Module Customer retrieveCustomerRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Raw XML)
 
(10 intermediate revisions not shown)
Line 13: Line 13:
|'''Input'''
|'''Input'''
|
|
-
*'''handle'''
+
*'''[[API Format Handle|handle]]'''
*withAdditionalData
*withAdditionalData
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
|
|
-
*handle
+
*[[API Format Handle|handle]]
*companyName
*companyName
-
*vat
+
*[[API Format vat|vat]]
*[[API Format Name|name]]
*[[API Format Name|name]]
-
*gender
+
*[[API Format Gender|gender]]
*[[API Format Address|address]]
*[[API Format Address|address]]
*[[API Format Phone|phone]]
*[[API Format Phone|phone]]
*[[API Format Phone|fax]]
*[[API Format Phone|fax]]
*email
*email
 +
*[[API Format EmailVerificationStatus|emailVerificationStatus]]
*[[API Format Additional Data Customer|additionalData]] (if withAdditionalData = true)
*[[API Format Additional Data Customer|additionalData]] (if withAdditionalData = true)
 +
*[[API_Format_Extensions_Additional_Data_Customer|extensionAdditionalData]] (if withAdditionalData = true)
|}
|}
Line 40: Line 42:
===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>
   <credentials>
   <credentials>
     <username>username</username>
     <username>username</username>
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <retrievecustomerrequest>
+
   <retrieveCustomerRequest>
     <handle>JH000001-US</handle>
     <handle>JH000001-US</handle>
-
     <withadditionaldata>0</withadditionaldata>
+
     <withAdditionalData>0</withAdditionalData>
-
   </retrievecustomerrequest>
+
   </retrieveCustomerRequest>
-
  </openxml>
+
  </openXML>
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
-
  <openxml>
+
  <openXML>
   <reply>
   <reply>
-
     < code>0</code>
+
     <nowiki><code>0</code></nowiki>
     <desc></desc>
     <desc></desc>
     <data>
     <data>
-
       <id>156384</id>
+
       <companyName>Hosting Unlimited</companyName>
-
      <companyname>Hosting Unlimited</companyname>
+
       <name>
       <name>
         <initials>J.B.</initials>
         <initials>J.B.</initials>
-
         <firstname>John</firstname>
+
         <firstName>John</firstName>
         <prefix>van</prefix>
         <prefix>van</prefix>
-
         <lastname>Halen</lastname>
+
         <lastName>Halen</lastName>
       </name>
       </name>
       <gender>M</gender>
       <gender>M</gender>
       <phone>
       <phone>
-
         <countrycode>+8</countrycode>
+
         <countryCode>+8</countryCode>
-
         <areacode>383</areacode>
+
         <areaCode>383</areaCode>
-
         <subscribernumber>1231212</subscribernumber>
+
         <subscriberNumber>1231212</subscriberNumber>
       </phone>
       </phone>
       <fax>
       <fax>
-
         <countrycode>+8</countrycode>
+
         <countryCode>+8</countryCode>
-
         <areacode>383</areacode>
+
         <areaCode>383</areaCode>
-
         <subscribernumber>1231213</subscribernumber>
+
         <subscriberNumber>1231213</subscriberNumber>
       </fax>
       </fax>
       <address>
       <address>
Line 88: Line 90:
       <handle>JH000001-US</handle>
       <handle>JH000001-US</handle>
       <comments></comments>
       <comments></comments>
-
      <resellerid>123915</resellerid>
 
     </data>
     </data>
   </reply>
   </reply>
-
  </openxml>
+
  </openXML>

Current revision as of 03:59, 21 July 2026

Contents

Module Customer > Retrieve

Module customer
Command name retrieveCustomerRequest
Use Retrieves information of an existing customer object
Input
Output

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>
Retrieved from "https://doc.openprovider.eu/API_Module_Customer_retrieveCustomerRequest"
Views
Personal tools