Offerit API List Affiliate Subaffiliates - Revision history

OfferitJames at 20:19, 6 May 2015

2015-05-06T20:19:58Z

OfferitMegan at 18:54, 1 February 2013

2013-02-01T18:54:04Z

OfferitRob at 17:38, 19 September 2012

2012-09-19T17:38:27Z

OfferitRob at 17:38, 19 September 2012

2012-09-19T17:38:01Z

OfferitRob at 17:37, 19 September 2012

2012-09-19T17:37:46Z

OfferitRobC at 22:52, 23 December 2011

2011-12-23T22:52:19Z

OfferitJames: /* Sample Output */

2011-12-09T18:53:43Z

‎Sample Output

OfferitJames at 18:45, 9 December 2011

2011-12-09T18:45:25Z

OfferitJames: Created page with "{{Offerit Manual | show_api_admin_section = true }} This function lists the sub affiliates under a specific affiliate. To use this function, you must make a SOAP call with the f..."

2011-10-19T21:53:41Z

Created page with "{{Offerit Manual | show_api_admin_section = true }} This function lists the sub affiliates under a specific affiliate. To use this function, you must make a SOAP call with the f..."

New page

{{Offerit Manual
| show_api_admin_section = true
}}

This function lists the sub affiliates under a specific affiliate. To use this function, you must make a SOAP call with the following parameters:

* '''loginid''' - The affiliate ID to get sub affiliates from
* '''start''' - (optional) The index to start on
* '''count''' - (optional) The amount of records to get
* '''order''' - (optional) The order of the records

<pre>
<?xml version="1.0" encoding="ISO-8859-1"?><SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:tns="urn:offeritapiadmin_wsdl"><SOAP-ENV:Body>
<tns:list_aff_subaffs xmlns:tns="urn:offeritapiadmin_wsdl">
<loginid xsi:type="xsd:int">2</loginid>
<start xsi:type="xsd:int">1</start>
<count xsi:type="xsd:int">10</count>
<order xsi:type="xsd:string">aff_subid</order>
</tns:list_aff_subaffs></SOAP-ENV:Body></SOAP-ENV:Envelope>
</pre>

You will get a response similar to the following:

<pre>
<?xml version="1.0" encoding="ISO-8859-1"?><SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body><ns1:list_aff_subaffsResponse xmlns:ns1="urn:offeritapiadmin_wsdl">
<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType=":[3]">
<item><additional_trackingid xsi:type="xsd:string">2</additional_trackingid>
<aff_subid xsi:type="xsd:string">asdfsadf</aff_subid>
<aff_subid2 xsi:type="xsd:string">asdf123423</aff_subid2>
<aff_subid3 xsi:type="xsd:string"></aff_subid3>
<aff_subid4 xsi:type="xsd:string"></aff_subid4>
<aff_subid5 xsi:type="xsd:string"></aff_subid5>
<loginid xsi:type="xsd:string">2</loginid></item>
<item><additional_trackingid xsi:type="xsd:string">3</additional_trackingid>
<aff_subid xsi:type="xsd:string">tester</aff_subid>
<aff_subid2 xsi:type="xsd:string">hello</aff_subid2>
<aff_subid3 xsi:type="xsd:string">adam</aff_subid3>
<aff_subid4 xsi:type="xsd:string"></aff_subid4>
<aff_subid5 xsi:type="xsd:string"></aff_subid5>
<loginid xsi:type="xsd:string">2</loginid></item>
<item><additional_trackingid xsi:type="xsd:string">1</additional_trackingid>
<aff_subid xsi:type="xsd:string">tmmadam</aff_subid>
<aff_subid2 xsi:type="xsd:string">adamtest</aff_subid2>
<aff_subid3 xsi:type="xsd:string"></aff_subid3>
<aff_subid4 xsi:type="xsd:string"></aff_subid4>
<aff_subid5 xsi:type="xsd:string"></aff_subid5>
<loginid xsi:type="xsd:string">2</loginid></item>
</return></ns1:list_aff_subaffsResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>
</pre>

== NuSOAP Example ==

This example continues from the [[Offerit_API#Example|main article NuSOAP Example]]):

<pre>
$values = Array(
'loginid' => 2,
'start' => 1,
'count' => 10,
'order' => 'aff_subaffs'
);
$result = $client->call('list_aff_subaffs', Array(), 'offeritapiadmin_wsdl');
</pre>

== Sample Output ==

<pre>
Array
(
[0] => Array
(
[additional_trackingid] => 2
[aff_subid] => asdfsadf
[aff_subid2] => asdf123423
[aff_subid3] =>
[aff_subid4] =>
[aff_subid5] =>
[loginid] => 2
)

[1] => Array
(
[additional_trackingid] => 3
[aff_subid] => tester
[aff_subid2] => hello
[aff_subid3] => adam
[aff_subid4] =>
[aff_subid5] =>
[loginid] => 2
)

[2] => Array
(
[additional_trackingid] => 1
[aff_subid] => tmmadam
[aff_subid2] => adamtest
[aff_subid3] =>
[aff_subid4] =>
[aff_subid5] =>
[loginid] => 2
)

)

</pre>

[[Category:Offerit API Articles]]

← Older revision		Revision as of 18:54, 1 February 2013
Line 63:		Line 63:

	)		)
−	~~</pre>~~
−
−	~~==Server Request/Response==~~
−	~~'''Request:'''~~
−	~~<pre>~~
−	~~<?xml version="1.0" encoding="ISO-8859-1"?><SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"~~
−	~~xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"~~
−	~~xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"~~
−	~~xmlns:tns="urn:offeritapiadmin_wsdl"><SOAP-ENV:Body>~~
−	~~<tns:list_aff_subaffs xmlns:tns="urn:offeritapiadmin_wsdl">~~
−	~~<loginid xsi:type="xsd:int">2</loginid>~~
−	~~<start xsi:type="xsd:int">1</start>~~
−	~~<count xsi:type="xsd:int">10</count>~~
−	~~<order xsi:type="xsd:string">subaff</order>~~
−	~~</tns:list_aff_subaffs></SOAP-ENV:Body></SOAP-ENV:Envelope>~~
−	~~</pre>~~
−
−	~~'''Response:'''~~
−	~~<pre>~~
−	~~<?xml version="1.0" encoding="ISO-8859-1"?><SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"~~
−	~~xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"~~
−	~~xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">~~
−	~~<SOAP-ENV:Body><ns1:list_aff_subaffsResponse xmlns:ns1="urn:offeritapiadmin_wsdl">~~
−	~~<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType=":[3]">~~
−	~~<item><additional_trackingid xsi:type="xsd:string">2</additional_trackingid>~~
−	~~<subaff xsi:type="xsd:string">asdfsadf</subaff>~~
−	~~<subaff2 xsi:type="xsd:string">asdf123423</subaff2>~~
−	~~<subaff3 xsi:type="xsd:string"></subaff3>~~
−	~~<subaff4 xsi:type="xsd:string"></subaff4>~~
−	~~<subaff5 xsi:type="xsd:string"></subaff5>~~
−	~~<loginid xsi:type="xsd:string">2</loginid></item>~~
−	~~<item><additional_trackingid xsi:type="xsd:string">3</additional_trackingid>~~
−	~~<subaff xsi:type="xsd:string">tester</subaff>~~
−	~~<subaff2 xsi:type="xsd:string">hello</subaff2>~~
−	~~<subaff3 xsi:type="xsd:string">adam</subaff3>~~
−	~~<subaff4 xsi:type="xsd:string"></subaff4>~~
−	~~<subaff5 xsi:type="xsd:string"></subaff5>~~
−	~~<loginid xsi:type="xsd:string">2</loginid></item>~~
−	~~<item><additional_trackingid xsi:type="xsd:string">1</additional_trackingid>~~
−	~~<subaff xsi:type="xsd:string">tmmadam</subaff>~~
−	~~<subaff2 xsi:type="xsd:string">adamtest</subaff2>~~
−	~~<subaff3 xsi:type="xsd:string"></subaff3>~~
−	~~<subaff4 xsi:type="xsd:string"></subaff4>~~
−	~~<subaff5 xsi:type="xsd:string"></subaff5>~~
−	~~<loginid xsi:type="xsd:string">2</loginid></item>~~
−	~~</return></ns1:list_aff_subaffsResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>~~
	</pre>		</pre>

@@ Line 19: / Line 19: @@
        'start' => 1,
        'count' => 10,
-       'order' => 'subaff2'
+       'order' => 'subaff'
     );
 $result = $client->call('list_aff_subaffs', $values, 'offeritapiadmin_wsdl');

← Older revision		Revision as of 22:52, 23 December 2011
Line 110:		Line 110:
	</return></ns1:list_aff_subaffsResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>		</return></ns1:list_aff_subaffsResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>
	</pre>		</pre>
−
−	~~[[Category:Offerit API Articles]]~~

@@ Line 24: / Line 24: @@
 </pre>
-== Sample Output ==
+=== Sample Output ===
 <pre>

@@ Line 7: / Line 7: @@
 * '''loginid''' - The affiliate ID to get sub affiliates from
 * '''start''' - (optional) The index to start on
-* '''count''' - (optional) The amount of records to get
+* '''count''' - (optional) The amount of records to get ''(25 results will be returned by default)''
 * '''order''' - (optional) The order of the records

@@ Line 32: / Line 32: @@
+         (
              [additional_trackingid] => 2
-             [aff_subid] => asdfsadf
+             [subaff] => asdfsadf
-             [aff_subid2] => asdf123423
+             [subaff2] => asdf123423
-             [aff_subid3] =>
+             [subaff3] =>
-             [aff_subid4] =>
+             [subaff4] =>
-             [aff_subid5] =>
+             [subaff5] =>
              [loginid] => 2
+         )
@@ Line 43: / Line 43: @@
+         (
              [additional_trackingid] => 3
-             [aff_subid] => tester
+             [subaff] => tester
-             [aff_subid2] => hello
+             [subaff2] => hello
-             [aff_subid3] => adam
+             [subaff3] => adam
-             [aff_subid4] =>
+             [subaff4] =>
-             [aff_subid5] =>
+             [subaff5] =>
              [loginid] => 2
+         )
@@ Line 54: / Line 54: @@
+         (
              [additional_trackingid] => 1
-             [aff_subid] => tmmadam
+             [subaff] => tmmadam
-             [aff_subid2] => adamtest
+             [subaff2] => adamtest
-             [aff_subid3] =>
+             [subaff3] =>
-             [aff_subid4] =>
+             [subaff4] =>
-             [aff_subid5] =>
+             [subaff5] =>
              [loginid] => 2
+         )
@@ Line 76: / Line 76: @@
 	<start xsi:type="xsd:int">1</start>
 	<count xsi:type="xsd:int">10</count>
-	<order xsi:type="xsd:string">aff_subid</order>
+	<order xsi:type="xsd:string">subaff</order>
 </tns:list_aff_subaffs></SOAP-ENV:Body></SOAP-ENV:Envelope>
 </pre>
@@ Line 88: / Line 88: @@
 <return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType=":[3]">
 <item><additional_trackingid xsi:type="xsd:string">2</additional_trackingid>
-	<aff_subid xsi:type="xsd:string">asdfsadf</aff_subid>
+	<subaff xsi:type="xsd:string">asdfsadf</subaff>
-	<aff_subid2 xsi:type="xsd:string">asdf123423</aff_subid2>
+	<subaff2 xsi:type="xsd:string">asdf123423</subaff2>
-	<aff_subid3 xsi:type="xsd:string"></aff_subid3>
+	<subaff3 xsi:type="xsd:string"></subaff3>
-	<aff_subid4 xsi:type="xsd:string"></aff_subid4>
+	<subaff4 xsi:type="xsd:string"></subaff4>
-	<aff_subid5 xsi:type="xsd:string"></aff_subid5>
+	<subaff5 xsi:type="xsd:string"></subaff5>
 	<loginid xsi:type="xsd:string">2</loginid></item>
 <item><additional_trackingid xsi:type="xsd:string">3</additional_trackingid>
-	<aff_subid xsi:type="xsd:string">tester</aff_subid>
+	<subaff xsi:type="xsd:string">tester</subaff>
-	<aff_subid2 xsi:type="xsd:string">hello</aff_subid2>
+	<subaff2 xsi:type="xsd:string">hello</subaff2>
-	<aff_subid3 xsi:type="xsd:string">adam</aff_subid3>
+	<subaff3 xsi:type="xsd:string">adam</subaff3>
-	<aff_subid4 xsi:type="xsd:string"></aff_subid4>
+	<subaff4 xsi:type="xsd:string"></subaff4>
-	<aff_subid5 xsi:type="xsd:string"></aff_subid5>
+	<subaff5 xsi:type="xsd:string"></subaff5>
 	<loginid xsi:type="xsd:string">2</loginid></item>
 <item><additional_trackingid xsi:type="xsd:string">1</additional_trackingid>
-	<aff_subid xsi:type="xsd:string">tmmadam</aff_subid>
+	<subaff xsi:type="xsd:string">tmmadam</subaff>
-	<aff_subid2 xsi:type="xsd:string">adamtest</aff_subid2>
+	<subaff2 xsi:type="xsd:string">adamtest</subaff2>
-	<aff_subid3 xsi:type="xsd:string"></aff_subid3>
+	<subaff3 xsi:type="xsd:string"></subaff3>
-	<aff_subid4 xsi:type="xsd:string"></aff_subid4>
+	<subaff4 xsi:type="xsd:string"></subaff4>
-	<aff_subid5 xsi:type="xsd:string"></aff_subid5>
+	<subaff5 xsi:type="xsd:string"></subaff5>
 	<loginid xsi:type="xsd:string">2</loginid></item>
 </return></ns1:list_aff_subaffsResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>
 </pre>

@@ Line 9: / Line 9: @@
 * '''count''' - (optional) The amount of records to get
 * '''order''' - (optional) The order of the records
 == NuSOAP Example ==
-This example continues from the [[Offerit_API#Example|main article NuSOAP Example]]):
+This example continues from the [[Offerit_API#Example|main article NuSOAP Example]]:
 <pre>
@@ Line 67: / Line 21: @@
        'order' => 'aff_subaffs'
     );
-$result = $client->call('list_aff_subaffs', Array(), 'offeritapiadmin_wsdl');
+$result = $client->call('list_aff_subaffs', $values, 'offeritapiadmin_wsdl');
 </pre>
@@ Line 109: / Line 63: @@
+)
 </pre>
 [[Category:Offerit API Articles]]