API Module Customer retrieveCustomerRequest
From Openprovider API documentation
(Difference between revisions)
| Line 41: | Line 41: | ||
===Raw XML=== | ===Raw XML=== | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| - | < | + | <openXML> |
<credentials> | <credentials> | ||
<username>username</username> | <username>username</username> | ||
<password>password</password> | <password>password</password> | ||
</credentials> | </credentials> | ||
| - | < | + | <retrieveCustomerRequest> |
<handle>JH000001-US</handle> | <handle>JH000001-US</handle> | ||
| - | < | + | <withadditionalData>0</withadditionalData> |
| - | </ | + | </retrieveCustomerRequest> |
| - | </ | + | </openXML> |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| - | < | + | <openXML> |
<reply> | <reply> | ||
< code>0</code> | < code>0</code> | ||
<desc></desc> | <desc></desc> | ||
<data> | <data> | ||
| - | < | + | <companyName>Hosting Unlimited</companyName> |
| - | + | ||
<name> | <name> | ||
<initials>J.B.</initials> | <initials>J.B.</initials> | ||
| - | < | + | <firstName>John</firstName> |
<prefix>van</prefix> | <prefix>van</prefix> | ||
| - | < | + | <lastName>Halen</lastName> |
</name> | </name> | ||
<gender>M</gender> | <gender>M</gender> | ||
<phone> | <phone> | ||
| - | < | + | <countryCode>+8</countryCode> |
| - | < | + | <areaCode>383</areaCode> |
| - | < | + | <subscriberNumber>1231212</subscriberNumber> |
</phone> | </phone> | ||
<fax> | <fax> | ||
| - | < | + | <countryCode>+8</countryCode> |
| - | < | + | <areaCode>383</areaCode> |
| - | < | + | <subscriberNumber>1231213</subscriberNumber> |
</fax> | </fax> | ||
<address> | <address> | ||
| Line 88: | Line 87: | ||
<handle>JH000001-US</handle> | <handle>JH000001-US</handle> | ||
<comments></comments> | <comments></comments> | ||
| - | |||
</data> | </data> | ||
</reply> | </reply> | ||
| - | </ | + | </openXML> |
Revision as of 13:33, 1 July 2010
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
<?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>