API Module Reseller createContactRequest

From Openprovider API documentation

Revision as of 09:23, 26 January 2011 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 10:57, 11 March 2011 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 16:		Line 16:
	*'''password'''		*'''password'''
	*'''role''' ''(can be admin, tech or billing)''		*'''role''' ''(can be admin, tech or billing)''
-	*'''isActive''' ''(can be 0 or 1)''	+	*'''isActive''' ''(can be 0 or 1; defaults to 1)''
	*companyName		*companyName
	*'''[[API Format Name|name]]'''		*'''[[API Format Name|name]]'''

---

Revision as of 10:57, 11 March 2011

Contents 1 Module Reseller > Create Contact 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Reseller > Create Contact

Module	reseller
Command name	createContactResellerRequest
Use	Creates a new contact in your reseller account
Input	username password role (can be admin, tech or billing) isActive (can be 0 or 1; defaults to 1) companyName 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>
    < code>0</code>
    <desc />
    <data>
      <id>5391</id>
    </data>
  </reply>
</openXML>