com.kassenterprises.soapserver
Class AplReportService

java.lang.Object
  |
  +--com.kassenterprises.soapserver.AplReportService

public class AplReportService

extends java.lang.Object

Overview

The AplReportService class offers service methods to request core portfolio accounting data in XML format. The primary method is getReportStream(). The getReportStream() method can be used to retrieve various types of data, often as XML documents. For example, you can request holdings (position and tax lots), transactions, gain/loss, and performace data using this method. PDF reports are also available via the getPDFStream() method.

The data set you retrieve is controlled by the value of the parameters you supply to the getReportStream() method. While the meaning of these parameters is documented in the API section below, this document provides the specifics about what reports are available and how to use the parameters to retrieve the specific data set of interest to you.

Note: A getVersion() service method is also supplied. This method may be used to retrieve the current name and version of the APL Navigator SOAP AplReportService. Note that this service can also be used as a simple test to check whether you can reach the AplReportService.

Constructor Summary

AplReportService()
Constructor is not used or needed to make requests on AplReportService

Method Summary

byte[]	getPDFStream(java.lang.String transId, java.lang.String customerCode, java.lang.String userId, java.lang.String reportName, java.lang.String startDate, java.lang.String endDate, java.lang.String filter, java.lang.String model, java.lang.String selectedAccount, java.lang.String allowableAccounts) For returning (binary) PDF data as the SOAP-ENC:Base64 subtype (instead * of as a string as the getReportStream() does).
java.lang.String	getPortfolio(java.lang.String transId, java.lang.String customerCode, java.lang.String userId, java.lang.String reportName, java.lang.String endDate, java.lang.String selectedAccount, java.lang.String allowableAccounts) Equivalent to making the call: getReportStream(transId, customerCode, userId, "AODTAXLOTSXML", null, endDate, selectedAccount, allowableAccounts).
java.lang.String	getReportStream(java.lang.String transId, java.lang.String customerCode, java.lang.String userId, java.lang.String reportName, java.lang.String startDate, java.lang.String endDate, java.lang.String selectedAccount, java.lang.String allowableAccounts)
java.lang.String	getReportStream(java.lang.String transId, java.lang.String customerCode, java.lang.String userId, java.lang.String reportName, java.lang.String startDate, java.lang.String endDate, java.lang.String filter, java.lang.String model, java.lang.String selectedAccount, java.lang.String allowableAccounts) Request a report stream (data set) from APL SOAP server
java.lang.String	getVersion(java.lang.String transId, java.lang.String customerCode) Request AplReportService Version #.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AplReportService

public AplReportService()

Constructor is not used or needed to make requests on AplReportService

Method Detail

getVersion

public java.lang.String getVersion(java.lang.String transId,
                                   java.lang.String customerCode)

Request AplReportService Version #. Doubles as a simple test that the service is up and running.

Parameters:

transId - ignored; reserved for future use of async messaging

customerCode - The APL Navigator acronym of customer making request

getReportStream

public java.lang.String getReportStream(java.lang.String transId,
                                        java.lang.String customerCode,
                                        java.lang.String userId,
                                        java.lang.String reportName,
                                        java.lang.String startDate,
                                        java.lang.String endDate,
                                        java.lang.String filter,
                                        java.lang.String model,
                                        java.lang.String selectedAccount,
                                        java.lang.String allowableAccounts)
                                 throws org.apache.soap.SOAPException

Request a report stream (data set) from APL SOAP server

Parameters:

transId - ignored; reserved for future use of async messaging

customerCode - The APL Navigator acronym of customer making request

userId - The APL Navigator user id request is on behalf of

reportName - The desired report

startDate - The start date for the report, if any; otherwise null

endDate - The end date for the report

filter - Filter criterion, if any; otherwise null

model - Model selection, if any; otherwise null

selectedAccount - Account selection to run report for

allowableAccounts - Temp override of user default for this field

Throws:

org.apache.soap.SOAPException -

See Also:

Available Reports and their Parameters and Schemas

getReportStream

public java.lang.String getReportStream(java.lang.String transId,
                                        java.lang.String customerCode,
                                        java.lang.String userId,
                                        java.lang.String reportName,
                                        java.lang.String startDate,
                                        java.lang.String endDate,
                                        java.lang.String selectedAccount,
                                        java.lang.String allowableAccounts)
                                 throws org.apache.soap.SOAPException

See Also:

getReportStream(String, String, String, String, String, String, String, String, String, String)

getPDFStream

public byte[] getPDFStream(java.lang.String transId,
                           java.lang.String customerCode,
                           java.lang.String userId,
                           java.lang.String reportName,
                           java.lang.String startDate,
                           java.lang.String endDate,
                           java.lang.String filter,
                           java.lang.String model,
                           java.lang.String selectedAccount,
                           java.lang.String allowableAccounts)
                    throws org.apache.soap.SOAPException

For returning (binary) PDF data as the SOAP-ENC:Base64 subtype (instead * of as a string as the getReportStream() does). Either one may be called with the same content resulting - just the subtype of the return element will be different. You may retrieve any APL Navigator enabled PDF report with this call.

See Also:

getReportStream(String, String, String, String, String, String, String, String, String, String).

getPortfolio

public java.lang.String getPortfolio(java.lang.String transId,
                                     java.lang.String customerCode,
                                     java.lang.String userId,
                                     java.lang.String reportName,
                                     java.lang.String endDate,
                                     java.lang.String selectedAccount,
                                     java.lang.String allowableAccounts)
                              throws org.apache.soap.SOAPException

Equivalent to making the call: getReportStream(transId, customerCode, userId, "AODTAXLOTSXML", null, endDate, selectedAccount, allowableAccounts). Note that the call to getReportStream() is preferred.