NATS4 API Set Affiliate Settings

From TMMwiki
Jump to: navigation, search
NATS 4
SOAP API
API
WSDL Cache
Add Affiliate
Add Member Note
Admin Get Adtools
Adtool Categories
Adtool Types
Affiliate Get Campaigns
Bulk Import Adtools
Caching
Decode Natscode
Expire Manual Member
Get Affiliate Campaigns
Get Affiliate Hit Data
Get Affiliate Loginids
Get Affiliate Nats Codes
Get Affiliate Payout
Get Affiliate Program Campaign List
Get_Affiliate_Program_Campaign_List
Get Member Details
Get Member Instant Upgrade String
Get Member Package Upgrade String
Get Member Token Rebuy String
Get Member Upsell String
Get Payment Data
Get Payvia Rule
Get Profit Loss Report
Ping
Record Member Login
Search Affiliate Info
Search Member Info
Send Email API Function
Set Affiliate Admin Settings
Set Affiliate Customs
Set Affiliate Defaults
Set Affiliate Information
Set Affiliate Settings
Set Member Details
Set Payment Status
Set Payvia Rule
REST API
API Overview
REST API PATH UPDATES
GET /adtools/types
GET /adtools/categories
GET /adtools/admin
POST /adtools/importdump
GET /affiliate/hitdata
GET /affiliate/campaigns
GET /affiliate/payout
GET /affiliate/searchinfo
POST /affiliate/addaffiliate
POST /affiliate/invoice
PATCH /affiliate/setcustoms
PATCH /affiliate/setinformation
PATCH /affiliate/setadminsettings
PATCH /affiliate/setpayviainfo
PATCH /affiliate/setdefaults
PATCH /affiliate/setsettings
GET /decodenatscode
GET /member/upsellstring
GET /member/tokenrebuystring
GET /member/instantupgradestring
GET /member/packageupgradestring
GET /member/details
GET /member/cancelstring
GET /member/signupplusstring
GET /member/searchinfo
POST /member/addnote
POST /member/recordlogin
PUT /member/expiremanual
PATCH /member/setdetails
PATCH /member/setexpiration
GET /option/getrule
POST /option/addrule
PUT /option/edittext
PATCH /option/editrule
GET /payments/getpayments
PATCH /payments/setstatus
GET /payviarule
PATCH /payviarule
GET /ping
GET /profitlossreport
POST /sendemail
GET /suggestedcanceloffers

To set an affiliate's settings 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:set_aff_settings xmlns:tns="urn:natsapiadmin_wsdl">
			<loginid xsi:type="xsd:int">5</loginid>
			<notify_password xsi:nil="true" xsi:type="xsd:int"/>
			<notify_payvia xsi:nil="true" xsi:type="xsd:int"/>
			<notify_payvia_info xsi:nil="true" xsi:type="xsd:int"/>
			<notify_defaults xsi:nil="true" xsi:type="xsd:int"/>
			<notify_details xsi:nil="true" xsi:type="xsd:int"/>
			<notify_settings xsi:nil="true" xsi:type="xsd:int"/>
			<notify_member_change xsi:nil="true" xsi:type="xsd:int"/>
			<notify_member_voided xsi:nil="true" xsi:type="xsd:int"/>
			<notify_member_chargeback xsi:nil="true" xsi:type="xsd:int"/>
			<notify_member_credited xsi:nil="true" xsi:type="xsd:int"/>
			<notify_member_insufficient xsi:nil="true" xsi:type="xsd:int"/>
			<notify_member_cancelled xsi:nil="true" xsi:type="xsd:int"/>
			<notify_member_rebilled xsi:nil="true" xsi:type="xsd:int"/>
			<notify_member_joined xsi:nil="true" xsi:type="xsd:int"/>
			<verify_details xsi:nil="true" xsi:type="xsd:int"/>
			<verify_settings xsi:nil="true" xsi:type="xsd:int"/>
			<verify_defaults xsi:nil="true" xsi:type="xsd:int"/>
			<verify_payvia xsi:nil="true" xsi:type="xsd:int"/>
			<verify_payvia_info xsi:nil="true" xsi:type="xsd:int"/>
			<email_promotional xsi:nil="true" xsi:type="xsd:int"/>
			<email_on_notify xsi:type="xsd:int">1</email_on_notify>
			<email_on_member_change xsi:nil="true" xsi:type="xsd:int"/>
			<email_on_member_voided xsi:nil="true" xsi:type="xsd:int"/>
			<email_on_member_chargeback xsi:nil="true" xsi:type="xsd:int"/>
			<email_on_member_credited xsi:nil="true" xsi:type="xsd:int"/>
			<email_on_member_insufficient xsi:nil="true" xsi:type="xsd:int"/>
			<email_on_member_cancelled xsi:nil="true" xsi:type="xsd:int"/>
			<email_on_member_rebilled xsi:nil="true" xsi:type="xsd:int"/>
			<email_on_member_joined xsi:nil="true" xsi:type="xsd:int"/>
			<access_preset xsi:nil="true" xsi:type="xsd:int"/>
			<post_member_approval xsi:nil="true" xsi:type="xsd:string"/>
			<post_member_rebill xsi:nil="true" xsi:type="xsd:string"/>
			<post_member_upgrade xsi:nil="true" xsi:type="xsd:string"/>
			<post_member_expire xsi:nil="true" xsi:type="xsd:string"/>
			<post_member_insufficient_fund xsi:nil="true" xsi:type="xsd:string"/>
			<post_member_credit xsi:nil="true" xsi:type="xsd:string"/>
			<post_member_chargeback xsi:nil="true" xsi:type="xsd:string"/>
			<post_member_void xsi:nil="true" xsi:type="xsd:string"/>
			<post_member_upgradedeny xsi:nil="true" xsi:type="xsd:string"/>
			<post_member_change_details xsi:nil="true" xsi:type="xsd:string"/>
		</tns:set_aff_settings>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

NOTE: The values for the fields are 0 for off or 1 for on.

You will get a response similar to:

<?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:set_aff_settingsResponse xmlns:ns1="urn:natsapiadmin_wsdl">
			<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Set_aff_setting[1]">
				<item xsi:type="tns:Set_aff_setting">
					<result xsi:type="xsd:int">1</result>
				</item>
			</return>
		</ns1:set_aff_settingsResponse>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The response contains one parameter named result. If the modification was successful, the result will be 1. If it was not successful, the result will be 0.