Firedrum Web Services API Toolkit 1.0.0 = Quick Start Guide

Assumptions:
 - Under Windows all files are installed in c:\tools
 - Under Linux or Mac OS X all files are installed in ~/tools
 
DOWNLOAD FWSAPI TOOLKIT
Download file firedrum-wsapi-1.0.0.zip and unzip in the tools directory.

3RD-PARTY PROGRAMS/TOOLS
Override default install locations to the above "tools" directory.
-	Java Development Kit 5.0 or equivalent.
    http://java.sun.com/javase/downloads/index_jdk5.jsp
-	Apache Ant 1.6.5 or later.
    http://ant.apache.org
-	Apache CXF web services framework, version 2.0.2 or later.
    http://incubator.apache.org/cxf

POST-INSTALL CONFIGURATION
- Update file firedrum-wsapi-1.0.0/bin/setEnv.bat (or setEnv.sh) to reflect the above
  program installations
- Update file firedrum-wsapi-1.0.0/build.properties, using the instructions at the
  top of the file. Typically only fwsapiClientUsername and fwsapiClientPassword
  need to be adjusted.

RUN THE EXAMPLE PROGRAM

The example program illustrates how to add new Members to your Firedrum account.
The Member data to be added in this case comes from a comma-separated-values file
transactionFile.csv. The program can be changed to use alternate sources of member data,
e.g. your CRM database, an Excel spreadsheet, etc.

To run the example program:
1.	Open a command prompt (or shell window in Linux/Mac OS X).
2.	Change to the firedrum-wsapi-1.0.0 directory. 
    E.G. in Windows issue the following command:
      cd c:\tools\firedrum-wsapi-1.0.0
3.	Issue the following command to set needed environment variables:
      bin\setEnv.bat
4.	Issue the following command to compile and run the program:
      ant 
5.	The output from the program is verbose. You can refer to the source code and
    readily match a line of output with the location in the source code that creates
    that output. 

SOURCE CODE AND DOCUMENTATION
The source for the example program is located in:
	firedrum-wsapi-1.0.0/src/com/acme/webservice/client/AddNewMemberClient.java
The documentation for the FWSAPI in Javadoc format can be viewed by navigating your web browser to:
    firedrum-wsapi-1.0.0/doc/api/index.html
 
WEB BROWSER ACCESS
Using a web browser to invoke selected Member Service methods:
-	http://www.FiredrumTestAccount.com/services/MemberService?wsdl 
This URL will retrieve the entire Member Service WSDL document to the web browser.
-	http://www.FiredrumTestAccount.com/services/MemberService/getCategoryList?clientUsername=[username]&clientPassword=[password] 
This URL will retrieve the list of Categories for the Client identified by the designated username and password.
-	http://www.FiredrumTestAccount.com/services/MemberService/getCustomFieldDefList?clientUsername=[username]&clientPassword=[password] 
This URL will retrieve the list of Custom Field Definitions (types) for the Client identified by the designated username and password.
-	http://www.FiredrumTestAccount.com/services/MemberService/getMemberListByEmail?clientUsername=[username]&clientPassword=[password]&memberEmail=First.Last@Domain.com 
This URL will retrieve the list the Member objects with an email address that matches the parameter memberEmail for the Client identified by the designated username and password.
 