WikiSysop: /* Module Reseller > Search Contact */

2016-06-17T11:17:05Z

Module Reseller > Search Contact

← Older revision		Revision as of 11:17, 17 June 2016
Line 13:		Line 13:
	\|'''Input'''		\|'''Input'''
	\|		\|
-	*limit ''default value: 100''	+	*[[API Format Limit\|limit]] (''default value: 100, maximum value: 1000'')
-	*offset ''default value: 0''	+	*[[API Format Offset\|offset]] (''default value: 0'')
	*emailPattern		*emailPattern
	*lastNamePattern		*lastNamePattern

WikiSysop at 11:16, 23 March 2012

2012-03-23T11:16:51Z

← Older revision		Revision as of 11:16, 23 March 2012
Line 46:		Line 46:

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

WikiSysop at 09:23, 26 January 2011

2011-01-26T09:23:20Z

← Older revision		Revision as of 09:23, 26 January 2011
Line 62:		Line 62:
	<openXML>		<openXML>
	<reply>		<reply>
-	<code >0</code>	+	< code>0</code>
	<desc />		<desc />
	<data>		<data>

WikiSysop at 09:04, 26 January 2011

2011-01-26T09:04:18Z

← Older revision		Revision as of 09:04, 26 January 2011
Line 23:		Line 23:
	\|'''Output'''		\|'''Output'''
	\|Result set of contact details:		\|Result set of contact details:
		+	*id
	*companyName		*companyName
	*[[API Format Name\|name]]		*[[API Format Name\|name]]

WikiSysop: Created page with '==Module Reseller > Search Contact== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |reseller |- style="background-color:#EEEEEE;" |'''Command n…'

2011-01-26T09:03:47Z

Created page with '==Module Reseller > Search Contact== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |reseller |- style="background-color:#EEEEEE;" |'''Command n…'

New page

==Module Reseller > Search Contact==
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|'''Module'''
|reseller
|- style="background-color:#EEEEEE;"
|'''Command name'''
|searchContactResellerRequest
|-
|'''Use'''
|Searches for contacts in your reseller account
|- style="vertical-align:top;"
|'''Input'''
|
*limit ''default value: 100''
*offset ''default value: 0''
*emailPattern
*lastNamePattern
*companyNamePattern
*usernamePattern
*role ''(can be admin, tech or billing)''
|- style="vertical-align:top;"
|'''Output'''
|Result set of contact details:
*companyName
*[[API Format Name|name]]
*[[API Format Address|address]]
*[[API Format Phone|phone]]
*email
*role
*isActive
*username
|}

==Examples==
===Using PHP class===
$request = new OP_Request;
$request->setCommand('searchContactRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'offset' => 0,
'limit' => 25,
'role' => 'tech',
));

===Raw XML===
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<credentials>
<username>username</username>
<password>password</password>
</credentials>
<searchContactRequest>
<offset>0</offset>
<limit>25</limit>
<role>tech</role>
</searchContactRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
<code >0</code>
<desc />
<data>
<results>
<array>
<item>
<id>5391</id>
<companyName></companyName>
<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>
<address>
<street></street>
<number></number>
<zipcode></zipcode>
<city></city>
<country></country>
</address>
<email>support@openprovider.nl</email>
<role>tech</role>
<isActive>1</isActive>
<username>newUser</username>
</item>
<item>
<id>3787</id>
<companyName></companyName>
<name>
<initials></initials>
<firstName>Andrew</firstName>
<prefix></prefix>
<lastName>Smith</lastName>
</name>
<gender>M</gender>
<phone>
<countryCode>+31</countryCode>
<areaCode>010</areaCode>
<subscriberNumber>4482299</subscriberNumber>
</phone>
<address>
<street></street>
<number></number>
<zipcode></zipcode>
<city></city>
<country></country>
</address>
<email>navin@hosting-concepts.nl</email>
<role>tech</role>
<isActive>1</isActive>
<username>andrew</username>
</item>
<item>
<id>4556</id>
<companyName></companyName>
<name>
<initials></initials>
<firstName>Will</firstName>
<prefix></prefix>
<lastName>Black</lastName>
</name>
<gender>M</gender>
<phone>
<countryCode>+1</countryCode>
<areaCode>952</areaCode>
<subscriberNumber>9350016</subscriberNumber>
</phone>
<address>
<street></street>
<number></number>
<zipcode></zipcode>
<city></city>
<country></country>
</address>
<email>support@openprovider.nl</email>
<role>tech</role>
<isActive>1</isActive>
<username>willb</username>
</item>
</array>
</results>
<total>3</total>
</data>
</reply>
</openXML>

API Module Reseller searchContactRequest - Revision history

WikiSysop: /* Module Reseller > Search Contact */

WikiSysop at 11:16, 23 March 2012

WikiSysop at 09:23, 26 January 2011

WikiSysop at 09:04, 26 January 2011

WikiSysop: Created page with '==Module Reseller > Search Contact== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |reseller |- style="background-color:#EEEEEE;" |'''Command n…'