API Module Reseller retrieveContactRequest - Revision history

WikiSysop: /* Raw XML */

2016-06-17T11:49:44Z

Raw XML

← Older revision		Revision as of 11:49, 17 June 2016
Line 52:		Line 52:
	<openXML>		<openXML>
	<reply>		<reply>
-	< code>0</code>	+	<nowiki><code>0</code></nowiki>
	<desc />		<desc />
	<data>		<data>

WikiSysop: /* Module Reseller > Retrieve Contact */

2016-06-17T11:26:06Z

Module Reseller > Retrieve Contact

← Older revision		Revision as of 11:26, 17 June 2016
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'''

WikiSysop: /* Module Reseller > Retrieve Contact */

2016-06-17T11:24:54Z

Module Reseller > Retrieve Contact

← Older revision		Revision as of 11:24, 17 June 2016
Line 22:		Line 22:
	*[[API Format Phone\|phone]]		*[[API Format Phone\|phone]]
	*email		*email
-	*role	+	*role ''(can be admin, tech or billing)''
	*isActive		*isActive
	*username		*username

WikiSysop at 11:16, 23 March 2012

2012-03-23T11:16:51Z

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

	===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:26Z

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

WikiSysop: Undo revision 165 by WikiSysop (Talk)

2011-01-26T09:16:42Z

Undo revision 165 by WikiSysop (Talk)

← Older revision		Revision as of 09:16, 26 January 2011
Line 13:		Line 13:
	\|'''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
		+	*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',~~	+
	));		));

Line 66:		Line 43:
	<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 93:		Line 54:
	<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>

WikiSysop at 09:15, 26 January 2011

2011-01-26T09:15:52Z

← Older revision		Revision as of 09:15, 26 January 2011
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>

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

2011-01-26T09:06:35Z

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

New page

==Module Reseller > Retrieve Contact==
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|'''Module'''
|reseller
|- style="background-color:#EEEEEE;"
|'''Command name'''
|retrieveContactResellerRequest
|-
|'''Use'''
|Retrieves information about a contact in your reseller account
|- style="vertical-align:top;"
|'''Input'''
|
*'''id'''
|- style="vertical-align:top;"
|'''Output'''
|
*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('retrieveContactRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'id' => 2292
));

===Raw XML===
<?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>