Difference between revisions of "NATS4 API Set Member Details"
From TMM Wiki
Jump to navigationJump to searchm (moved NATS4 API Set Member Information to NATS4 API Set Member Details: Function is really called Set Member Details) |
|||
| Line 16: | Line 16: | ||
* '''city''' | * '''city''' | ||
* '''state''' | * '''state''' | ||
| − | * ''' | + | * '''zip''' |
* '''country''' | * '''country''' | ||
* '''custom1''' | * '''custom1''' | ||
Revision as of 12:44, 31 December 2009
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
- 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_details xmlns:tns="urn:natsapiadmin_wsdl"> <memberid xsi:type="xsd:int">88</memberid> <firstname xsi:type="xsd:string">joe</firstname> <lastname xsi:type="xsd:string">montana</lastname> <email xsi:type="xsd:string">joe@joe.com</email> <address1 xsi:type="xsd:string">301 football way</address1> <address2 xsi:type="xsd:string">PO Box 123</address2> <city xsi:type="xsd:string">Winslow</city> <state xsi:type="xsd:string">AZ</state> <country xsi:type="xsd:string">USA</country> <zip xsi:type="xsd:string">12345</zip> <password xsi:type="xsd:string">pantaloons</password> <custom1 xsi:type="xsd:string">sometimes when we touch</custom1> <custom2 xsi:type="xsd:string">the honesty's too much</custom2> <custom3 xsi:type="xsd:string">and I have to close my eyes</custom3> <custom4 xsi:type="xsd:string">and hide</custom4> <custom5 xsi:nil="true" xsi:type="xsd:string"/> </tns:set_member_details> </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/"> <SOAP-ENV:Body> <ns1:set_member_detailsResponse xmlns:ns1="urn:natsapiadmin_wsdl"> <return xsi:type="xsd:boolean">true</return> </ns1:set_member_detailsResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
The response contains one parameter named result. If the modification was successful then result will be TRUE. If it was not successful then the result will be FALSE.
NuSOAP Example (continuing from main article NuSOAP Example):
$values = array(
'memberid' => 88,
'password' => 'pantaloons',
'firstname' => 'joe',
'lastname' => 'montana',
'email' => 'joe@joe.com',
'address1' => '301 football way',
'address2' => 'PO Box 123',
'zip' => '12345',
'city' => 'Winslow',
'state' => 'AZ',
'country' => 'USA',
'custom1' => 'sometimes when we touch',
'custom2' => "the honesty's too much",
'custom3' => 'and I have to close my eyes',
'custom4' => 'and hide',
);
$result = $client->call('set_member_details', $values, 'natsapiadmin_wsdl');
var_dump($result);
Output:
bool(true)
