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 Reseller retrieveContactRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Reseller > Retrieve Contact== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |reseller |- style="background-color:#EEEEEE;" |'''Command…')
Line 13: Line 13:
|'''Input'''
|'''Input'''
|
|
-
*'''id'''
+
*'''username'''
 +
*'''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'''
|
|
-
*companyName
+
*id
-
*[[API Format Name|name]]
+
-
*[[API Format Address|address]]
+
-
*[[API Format Phone|phone]]
+
-
*email
+
-
*role
+
-
*isActive
+
-
*username
+
|}
|}
Line 30: Line 33:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('retrieveContactRequest')
+
  $request->setCommand('createContactRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
-
     'id' => 2292
+
     'username' => 'newUser',
 +
    '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',
  ));
  ));
Line 43: Line 66:
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <retrieveContactRequest>
+
   <createContactRequest>
-
     <id>2292</id>
+
     <username>newUser</username>
-
   </retrieveContactRequest>
+
    <password>newPassword</password>
 +
    <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 54: Line 93:
     <desc />
     <desc />
     <data>
     <data>
-
       <id>2292</id>
+
       <id>5391</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>

Revision as of 09:15, 26 January 2011

Contents

Module Reseller > Retrieve Contact

Module reseller
Command name retrieveContactResellerRequest
Use Retrieves information about a contact in your reseller account
Input
  • username
  • password
  • role (can be admin, tech or billing)
  • isActive (can be 0 or 1)
  • companyName
  • vat
  • name
  • gender
  • address
  • phone
  • email
Output
  • id

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('createContactRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
   'username' => 'newUser',
   '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

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <createContactRequest>
    <username>newUser</username>
    <password>newPassword</password>
    <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>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    0
    <desc />
    <data>
      <id>5391</id>
    </data>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Reseller_retrieveContactRequest"
Views
Personal tools