NATS4 API Set Member Details
From TMM Wiki
Jump to navigationJump to search
This feature is available as of version 4.0.71.1
set_member_information requires the following parameters:
- memberid The nats memberid of the member being updated.
set_member_information accepts the following additional parameters (requiring at least one of these):
- firstname
- lastname
- password
- address1
- address2
- city
- state
- zip_code
- country
- custom1
- custom2
- custom3
- custom4
- custom5
If you want to remove a field you can pass in the string REMOVE and the field will be removed. The following fields have this ability:
- Address2
- state
Here's an example of the request:
<?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_member_informations xmlns:tns="urn:natsapiadmin_wsdl"> <memberid xsi:type="xsd:int">6</memberid> <firstname xsi:nil="true" xsi:type="xsd:string"> <lastname xsi:nil="true" xsi:type="xsd:string"/> <email xsi:nil="true" xsi:type="xsd:string"/> <address1 xsi:nil="true" xsi:type="xsd:string"/> <address2 xsi:nil="true" xsi:type="xsd:string"/> <city xsi:nil="true" xsi:type="xsd:string"/> <state xsi:nil="true" xsi:type="xsd:string"/> <country xsi:nil="true" xsi:type="xsd:string"/> <zip_code xsi:nil="true" xsi:type="xsd:string"/> <custom1 xsi:nil="true" xsi:type="xsd:string"/> <custom2 xsi:nil="true" xsi:type="xsd:string"/> <custom3 xsi:nil="true" xsi:type="xsd:string"/> <custom4 xsi:nil="true" xsi:type="xsd:string"/> <custom5 xsi:nil="true" xsi:type="xsd:string"/> <password xsi:nil="true" xsi:type="xsd:string"/> </tns:set_member_informations> </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:set_member_informationsResponse xmlns:ns1="urn:natsapiadmin_wsdl"> <return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Set_member_informations[TRUE]"> <item xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Set_member_informations[TRUE]"> <item xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Set_member_informations[FALSE]"> </item> </item> </return> </ns1:set_member_informationsResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
The response contains one parameters named result. If the modification was successful then result will be TRUE. If it was not successful then the result will be FALSE.