NATS4 API Set Affiliate Settings
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
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.