API Module Reseller retrieveContactRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Raw XML)
 
(5 intermediate revisions not shown)
Line 9: Line 9:
|-
|-
|'''Use'''
|'''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;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
|
|
-
*'''username'''
+
*'''id'''
-
*'''password'''
+
-
*'''role''' ''(can be admin, tech or billing)''
+
-
*'''isActive''' ''(can be 0 or 1)''
+
-
*companyName
+
-
*vat
+
-
*'''[[API Format Name|name]]'''
+
-
*'''gender'''
+
-
*'''[[API Format Address|address]]'''
+
-
*'''[[API Format Phone|phone]]'''
+
-
*'''email'''
+
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
|
|
-
*id
+
*companyName
 +
*[[API Format Name|name]]
 +
*[[API Format Address|address]]
 +
*[[API Format Phone|phone]]
 +
*email
 +
*role ''(can be admin, tech or billing)''
 +
*isActive
 +
*username
|}
|}
Line 33: Line 30:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('createContactRequest')
+
  $request->setCommand('retrieveContactRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
-
     'username' => 'newUser',
+
     'id' => 2292
-
    'password' => 'newPassword',
+
-
    'role'    => 'tech',
+
-
    'isActive' => 1,
+
-
+
-
    'name' => array(
+
-
      'initials' => 'J.B.',
+
-
      'firstName' => 'John',
+
-
      'prefix' => 'van',
+
-
      'lastName' => 'Halen',
+
-
    ),
+
-
+
-
    'gender' => 'M',
+
-
+
-
    'phone' => array(
+
-
      'countryCode' => '+31',
+
-
      'areaCode' => '10',
+
-
      'subscriberNumber' => '4482299'
+
-
    ),
+
-
+
-
    'email' => 'support@openprovider.nl',
+
  ));
  ));
===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>
Line 66: Line 44:
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <createContactRequest>
+
   <retrieveContactRequest>
-
     <username>newUser</username>
+
     <id>2292</id>
-
    <password>newPassword</password>
+
   </retrieveContactRequest>
-
    <role>tech</role>
+
-
    <isActive>1</isActive>
+
-
    <name>
+
-
      <initials>J.B.</initials>
+
-
      <firstName>John</firstName>
+
-
      <prefix>van</prefix>
+
-
      <lastName>Halen</lastName>
+
-
    </name>
+
-
    <gender>M</gender>
+
-
    <phone>
+
-
      <countryCode>+31</countryCode>
+
-
      <areaCode>10</areaCode>
+
-
      <subscriberNumber>4482299</subscriberNumber>
+
-
    </phone>
+
-
    <email>support@openprovider.nl</email>
+
-
   </createContactRequest>
+
  </openXML>
  </openXML>
Line 90: Line 52:
  <openXML>
  <openXML>
   <reply>
   <reply>
-
     <code >0</code>
+
     <nowiki><code>0</code></nowiki>
     <desc />
     <desc />
     <data>
     <data>
-
       <id>5391</id>
+
       <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>
     </data>
   </reply>
   </reply>
  </openXML>
  </openXML>

Current revision as of 11:49, 17 June 2016

Contents

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