PortfolioLinkApi

<back to all web services

CalculateSustainableIncome

Requires Authentication
The following routes are available for this service:
All Verbs/sustainableIncome
CalculateSustainableIncome Parameters:
NameParameterData TypeRequiredDescription
CurrentSavingsquerydecimalNo
CurrentAgequeryintNo
LifeExpectancyAgequeryintNo
PortfolioReturnquerydecimalNo
PortfolioVolatilityquerydecimalNo
AdvisorFeesquerydecimalNo
ExpectedInflationRatequerydecimalNo
CalculateSustainableIncomeResponse Parameters:
NameParameterData TypeRequiredDescription
SustainableIncomeListformDictionary<int, decimal>No
SustainableIncomeformdecimalNo

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 /sustainableIncome HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CalculateSustainableIncome xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <AdvisorFees>0</AdvisorFees>
  <CurrentAge>0</CurrentAge>
  <CurrentSavings>0</CurrentSavings>
  <ExpectedInflationRate>0</ExpectedInflationRate>
  <LifeExpectancyAge>0</LifeExpectancyAge>
  <PortfolioReturn>0</PortfolioReturn>
  <PortfolioVolatility>0</PortfolioVolatility>
</CalculateSustainableIncome>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CalculateSustainableIncomeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <SustainableIncome>0</SustainableIncome>
  <SustainableIncomeList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintdecimal>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfintdecimal>
  </SustainableIncomeList>
</CalculateSustainableIncomeResponse>