PortfolioLinkApi

<back to all web services

GetContributionCashFlowRequest

Requires Authentication
The following routes are available for this service:
All Verbs/projections/contribution
GetContributionCashFlowRequest Parameters:
NameParameterData TypeRequiredDescription
KeyIndexqueryintNo
ContributionLabelquerystringNo
ApplyContributionqueryboolNo
ContributionquerydecimalNo
ContributionGrowthquerydecimalNo
ContributionGrowthFrequencyquerydecimalNo
ContributionFrequencyqueryintNo
ContributionStartYearqueryintNo
ContributionToLastqueryintNo
GetContributionCashFlowResponse Parameters:
NameParameterData TypeRequiredDescription
IncomesformList<IncomeView>No
IncomeView Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
IncomeformdecimalNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /projections/contribution HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetContributionCashFlowRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <ApplyContribution>false</ApplyContribution>
  <Contribution>0</Contribution>
  <ContributionFrequency>0</ContributionFrequency>
  <ContributionGrowth>0</ContributionGrowth>
  <ContributionGrowthFrequency>0</ContributionGrowthFrequency>
  <ContributionLabel>String</ContributionLabel>
  <ContributionStartYear>0</ContributionStartYear>
  <ContributionToLast>0</ContributionToLast>
  <KeyIndex>0</KeyIndex>
</GetContributionCashFlowRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetContributionCashFlowResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Incomes xmlns:d2p1="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel.Types">
    <d2p1:IncomeView>
      <d2p1:Income>0</d2p1:Income>
      <d2p1:Year>0</d2p1:Year>
    </d2p1:IncomeView>
  </Incomes>
</GetContributionCashFlowResponse>