NATS4 API Set Affiliate Admin Settings
From TMM Wiki
Revision as of 12:28, 29 June 2010 by TMMStephenY2 (talk | contribs)
To set an affiliates Admin Settings through the NATS4 API 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_admin_settings xmlns:tns="urn:natsapiadmin_wsdl"> <loginid xsi:type="xsd:int">6</loginid> <select1 xsi:type="xsd:int">0</select1> <select2 xsi:nil="true" xsi:type="xsd:int"/> <select3 xsi:nil="true" xsi:type="xsd:int"/> <select4 xsi:nil="true" xsi:type="xsd:int"/> <select5 xsi:nil="true" xsi:type="xsd:int"/> <flag1 xsi:nil="true" xsi:type="xsd:int"/> <flag2 xsi:type="xsd:int">1</flag2> <flag3 xsi:nil="true" xsi:type="xsd:int"/> <flag4 xsi:nil="true" xsi:type="xsd:int"/> <flag5 xsi:nil="true" xsi:type="xsd:int"/> <reviewed xsi:nil="true" xsi:type="xsd:int"/> <reason xsi:nil="true" xsi:type="xsd:string"/> <invoicer xsi:nil="true" xsi:type="xsd:int"/> <req_docs xsi:nil="true" xsi:type="xsd:int"/> <w9 xsi:type="xsd:int">1</w9> <trust_level xsi:nil="true" xsi:type="xsd:int"/> </tns:set_aff_admin_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_admin_settingsResponse xmlns:ns1="urn:natsapiadmin_wsdl"> <return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Set_aff_admin_setting[1]"> <item xsi:type="tns:Set_aff_admin_setting"> <result xsi:type="xsd:int">1</result> </item> </return> </ns1:set_aff_admin_settingsResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
The response will contain one parameter named result. If the modification was successful then the result will be 1; if it was not successful then the result will be 0.