Difference between revisions of "NATS4 API Add Affiliate"

From TMM Wiki
Jump to navigationJump to search
(New page: {{NATS4 Manual}} To add an affiliate you must make a SOAP call with the following parameters: <pre> <?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="h...)
 
m (NATS4 API add aff moved to NATS4 API Add Affiliate: Rename title)
(No difference)

Revision as of 09:24, 10 April 2009

NATS 4
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers

To add an affiliate 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:add_affs xmlns:tns="urn:natsapiadmin_wsdl">
			<username xsi:type="xsd:string">NewAffiliate</username>
			<password xsi:type="xsd:string">AffPass</password>
			<firstname xsi:type="xsd:string">MyFirst</firstname>
			<lastname xsi:type="xsd:string">MyLast</lastname>
			<email xsi:type="xsd:string">foo@bar.com</email>
			<company xsi:nil="true" xsi:type="xsd:string"/>
			<url xsi:type="xsd:string">http://www.foo.com</url>
			<tel xsi:nil="true" xsi:type="xsd:string"/>
			<icq xsi:nil="true" xsi:type="xsd:string"/>
			<aim xsi:nil="true" xsi:type="xsd:string"/>
			<msn xsi:nil="true" xsi:type="xsd:string"/>
			<address1 xsi:type="xsd:string">505 Street Rd.</address1>
			<address2 xsi:nil="true" xsi:type="xsd:string"/>
			<city xsi:type="xsd:string">Freehold</city>
			<state xsi:type="xsd:string">NJ</state>
			<country xsi:type="xsd:string">US</country>
			<zip_code xsi:type="xsd:string">12345</zip_code>
			<tax_id_or_ssn xsi:nil="true" xsi:type="xsd:string"/>
		</tns:add_affs>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


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

The response contains two parameters, result and loginid. If the add was successful then result will be 1, otherwise it will be the error message with the issue. If the add was successful then loginid will be the affiliates loginid otherwise it will be 0.