API Module Customer retrieveCustomerRequest
From Openprovider API documentation
(Difference between revisions)
(→Raw XML) |
|||
| (7 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]] | ||
| Line 29: | Line 29: | ||
*[[API Format EmailVerificationStatus|emailVerificationStatus]] | *[[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 50: | Line 51: | ||
<retrieveCustomerRequest> | <retrieveCustomerRequest> | ||
<handle>JH000001-US</handle> | <handle>JH000001-US</handle> | ||
| - | < | + | <withAdditionalData>0</withAdditionalData> |
</retrieveCustomerRequest> | </retrieveCustomerRequest> | ||
</openXML> | </openXML> | ||
| Line 57: | Line 58: | ||
<openXML> | <openXML> | ||
<reply> | <reply> | ||
| - | < code>0</code> | + | <nowiki><code>0</code></nowiki> |
<desc></desc> | <desc></desc> | ||
<data> | <data> | ||
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>