NATS4 API Adtool Types

From Tmmwiki
Jump to: navigation, search
NATS 4
API
API
Add Affiliate
Admin Get Adtools
Adtool Types
Adtool Categories
Ping
Affiliate Get Campaigns
Get Member Details
Get Member Instant Upgrade String
Get Member Package Upgrade String
Get Member Upsell String
Get Member Token Rebuy String
Set Affiliate Defaults
Set Affiliate Admin Settings
Set Affiliate Customs
Decode Natscode
Set Affiliate Information
Set Affiliate Settings
Set Member Details
Bulk Import Adtools
Send Email API Function
Add Manual Member
Expire Manual Member

This function allows you to get a list of available adtool types. To use this function, you must make a SOAP call with the following parameters:

<?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:natsapiadmin_wsdl">
<SOAP-ENV:Body>
	<tns:adtool_types xmlns:tns="urn:natsapiadmin_wsdl">
	</tns:adtool_types>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

You will get a response similar to the following; keep in mind that 16 adtool types were available, but they were reduced down to 4 for display purposes.

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope 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:natsapiadmin_wsdl">
<SOAP-ENV:Body>
	<ns1:adtool_typesResponse xmlns:ns1="urn:natsapiadmin_wsdl">
		<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Adtool_type[16]">
			<item xsi:type="tns:Adtool_type">
				<adtool_type_id xsi:type="xsd:int">1</adtool_type_id>
				<adtool_category_id xsi:type="xsd:int">1</adtool_category_id>
				<name xsi:type="xsd:string">Static Banners</name>
				<description xsi:type="xsd:string">Static Banners</description>
			</item>
			<item xsi:type="tns:Adtool_type">
				<adtool_type_id xsi:type="xsd:int">2</adtool_type_id>
				<adtool_category_id xsi:type="xsd:int">2</adtool_category_id>
				<name xsi:type="xsd:string">FHG</name>
				<description xsi:type="xsd:string">Free Hosted Galleries</description>
			</item>
			<item xsi:type="tns:Adtool_type">
				<adtool_type_id xsi:type="xsd:int">3</adtool_type_id>
				<adtool_category_id xsi:type="xsd:int">3</adtool_category_id>
				<name xsi:type="xsd:string">Page Ads</name>
				<description xsi:type="xsd:string">Half Page / Full Page Ads</description>
			</item>
			<item xsi:type="tns:Adtool_type">
				<adtool_type_id xsi:type="xsd:int">4</adtool_type_id>
				<adtool_category_id xsi:type="xsd:int">3</adtool_category_id>
				<name xsi:type="xsd:string">Content</name>
				<description xsi:type="xsd:string">Downloadable Content</description>
			</item>
		</return>
	</ns1:adtool_typesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


NuSOAP Example

This example continues from the main article NuSOAP Example):

$result = $client->call('adtool_types', Array(), 'natsapiadmin_wsdl');
var_dump($result);

Sample Output

16 adtool types were available, but have been reduced down to 4 for display:

array(16) {
  [0]=>
  array(4) {
    ["adtool_type_id"]=>
    int(1)
    ["adtool_category_id"]=>
    int(1)
    ["name"]=>
    string(14) "Static Banners"
    ["description"]=>
    string(14) "Static Banners"
  }
  [1]=>
  array(4) {
    ["adtool_type_id"]=>
    int(2)
    ["adtool_category_id"]=>
    int(2)
    ["name"]=>
    string(3) "FHG"
    ["description"]=>
    string(21) "Free Hosted Galleries"
  }
  [2]=>
  array(4) {
    ["adtool_type_id"]=>
    int(3)
    ["adtool_category_id"]=>
    int(3)
    ["name"]=>
    string(8) "Page Ads"
    ["description"]=>
    string(25) "Half Page / Full Page Ads"
  }
  [3]=>
  array(4) {
    ["adtool_type_id"]=>
    int(4)
    ["adtool_category_id"]=>
    int(3)
    ["name"]=>
    string(7) "Content"
    ["description"]=>
    string(20) "Downloadable Content"
  }
}
Personal tools
products