APL Navigator SOAP - User Guide

Available Reports and their Parameters and Schemas

Report data is generally accessible using the getReportStream() method. Essentially, you will distinguish which report or "data set" (XML document) to retrieve using the reportName parameter. For each reportName, the other parameters control the end content you will receive.

This list details the current available data sets and their corresponding required parameters (and schemas):

• Holdings: Firmwide Position
  reportName=AODFWHOLDINGSXML (firmWidePositions.xsd) (html)
  requires endDate, selectedAccount
• Holdings: Position
  reportName=AODHOLDINGSXML (portfolioPositions.xsd) (html)
  requires endDate, selectedAccount
• Holdings: Taxlots
  reportName=AODTAXLOTSXML (portfolioTaxLots.xsd) (html)
  requires endDate, selectedAccount
• Holdings: Allocation
  reportName=AODALLOCXML (portfolioAllocation.xsd) (html)
  requires selectedAccount
• Holdings: Historical Market Value
  reportName=AODHISTMVXML (histMarketValue.xsd) (html)
  requires endDate, selectedAccount
• Holdings: Review
  reportName=AODREVIEWTOTXML (portfolioReview.xsd) (html)
  requires startDate, endDate, selectedAccount
• Transactions
  reportName=AODTRANSXML (transactionHistory.xsd) (html)
  requires startDate, endDate, selectedAccount
• Gain/Loss
  reportName=AODGAINLOSSXML (gainLossSchedule.xsd) (html)
  requires startDate, endDate, selectedAccount
• Performance
  reportName=AODPERFXML (portfolioPerformance.xsd) (html)
  requires endDate, filter, model, selectedAccount
  
  reportName=AODPERFHISTXML (performanceHistory.xsd) (html)
  requires startDate, endDate, filter, model, selectedAccount
  
  Note:
  • In the performance context, the filter parameter is used to indicate the performance sector(s) of interest. e.g. filter="P01" or filter="P01 P02 P03", etc.
  • In the performance context, the model parameter is used to indicate the benchmarks/indices of interest. e.g. model="SP500T" or model="SP500T DJIAT"

Parameters that are not required for a particular data should be passed as null or empty strings. Regardless, they will be ignored if they are not needed. Note that transId (reserved for future async messaging) and allowableAccounts (which may be provided to override the APL Navigator value for the corresponding user) are always optional.

The parameters customerCode (your APL Navigator assigned acronym) and userId (the APL Navigator user on whose behalf the request is being made) are always required. If a required parameter is not supplied for a particular data set, the request will most likely fail.

Note that there are actually two getReportStream() methods with slightly different parameter sets. In general, you may use either one. If however, your data set requires the filter or model parameter, you will need to use the more extensive call. See the API documentation for AplReportService for more information.

Date format may be either mm/dd/ccyy or ccyy-mm-dd (e.g. 06/30/2002, or 2002-06-30 for June 30, 2002). Note that startDate and endDate should be passed as strings (as opposed to any fancy Date object).