API Module Reseller createContactRequest

From Openprovider API documentation

Revision as of 09:20, 26 January 2011 (view source) WikiSysop (Talk | contribs) ← Older edit		Current revision as of 11:58, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Reseller > Create Contact)
(10 intermediate revisions not shown)
Line 9:		Line 9:
	|-		|-
	|'''Use'''		|'''Use'''
-	|Creates a new contact in your reseller account	+	|Create new responsible contact in your reseller account
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Input'''		|'''Input'''
Line 15:		Line 15:
	*'''username'''		*'''username'''
	*'''password'''		*'''password'''
-	*'''role''' ''(can be admin, tech or billing)''	+	*'''role''' ''('tech' or 'billing' (only one billing contact can be created per reseller account))''
-	*'''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]]'''
-	*'''gender'''	+	*'''[[API Format Gender|gender]]'''
-	*'''[[API Format Address|address]]'''	+	*[[API Format Address|address]]
	*'''[[API Format Phone|phone]]'''		*'''[[API Format Phone|phone]]'''
	*'''email'''		*'''email'''
Line 59:		Line 59:
	===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 89:		Line 90:
	<openXML>		<openXML>
	<reply>		<reply>
-	<code >0</code>	+	<nowiki><code>0</code></nowiki>
	<desc />		<desc />
	<data>		<data>

---

Current revision as of 11:58, 17 June 2016

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	Create new responsible contact in your reseller account
Input	username password role ('tech' or 'billing' (only one billing contact can be created per reseller account)) 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

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