PortfolioLinkApi

<back to all web services

AdditionalGetContributionCashFlowRequest

Requires Authentication
The following routes are available for this service:
All Verbs/projections/additionalcontribution
AdditionalGetContributionCashFlowRequest Parameters:
NameParameterData TypeRequiredDescription
AdditionalGetContributionCashFlowRequestsqueryList<GetContributionCashFlowRequest>No
GetContributionCashFlowRequest Parameters:
NameParameterData TypeRequiredDescription
KeyIndexformintNo
ContributionLabelformstringNo
ApplyContributionformboolNo
ContributionformdecimalNo
ContributionGrowthformdecimalNo
ContributionGrowthFrequencyformdecimalNo
ContributionFrequencyformintNo
ContributionStartYearformintNo
ContributionToLastformintNo
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/additionalcontribution HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AdditionalGetContributionCashFlowRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <AdditionalGetContributionCashFlowRequests>
    <GetContributionCashFlowRequest>
      <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>
  </AdditionalGetContributionCashFlowRequests>
</AdditionalGetContributionCashFlowRequest>
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>