API Module Reseller retrieveContactRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 11:49, 17 June 2016

Module Reseller > Retrieve Contact

Module	reseller
Command name	retrieveContactResellerRequest
Use	Retrieves information about responsible contacts (administrative, technical or billing) in your reseller account
Input	id
Output	companyName name address phone email role (can be admin, tech or billing) isActive username

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveContactRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
   'id' => 2292
));

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>
  <retrieveContactRequest>
    <id>2292</id>
  </retrieveContactRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc />
    <data>
      <id>2292</id>
      <companyName></companyName>
      <name>
        <initials></initials>
        <firstName>Will</firstName>
        <prefix></prefix>
        <lastName>Black</lastName>
      </name>
      <gender>M</gender>
      <phone>
        <countryCode>+31</countryCode>
        <areaCode>10</areaCode>
        <subscriberNumber>4482292</subscriberNumber>
      </phone>
      <address>
        <street></street>
        <number></number>
        <zipcode></zipcode>
        <city></city>
        <country>NL</country>
      </address>
      <email>support@openprovider.nl</email>
      <role>admin</role>
      <isActive>1</isActive>
      <username>willb</username>
    </data>
  </reply>
</openXML>

@@ Line 9: / Line 9: @@
 |-
 |'''Use'''
-|Retrieves information about a contact in your reseller account
+|Retrieves information about responsible contacts (administrative, technical or billing) in your reseller account
 |- style="vertical-align:top;"
 |'''Input'''
@@ Line 22: / Line 22: @@
 *[[API Format Phone|phone]]
 *email
-*role
+*role ''(can be admin, tech or billing)''
 *isActive
 *username
@@ Line 37: / Line 37: @@
 ===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>
@@ Line 51: / Line 52: @@
   <openXML>
     <reply>
-      < code>0</code>
+      <nowiki><code>0</code></nowiki>
       <desc />
       <data>