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 /historical/cashflow HTTP/1.1
Host: api.portfoliolink.co.za
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetHistoricalCashFlow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
<AdjustForInflation>false</AdjustForInflation>
<AdvisorFee>0</AdvisorFee>
<AssetAllocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharedTypes">
<d2p1:Africa>0</d2p1:Africa>
<d2p1:AfricaEuroBondsExSouthAfrica>0</d2p1:AfricaEuroBondsExSouthAfrica>
<d2p1:Commodity>0</d2p1:Commodity>
<d2p1:ForeignBonds>0</d2p1:ForeignBonds>
<d2p1:ForeignBondsHedge>0</d2p1:ForeignBondsHedge>
<d2p1:ForeignCash>0</d2p1:ForeignCash>
<d2p1:ForeignEquity>0</d2p1:ForeignEquity>
<d2p1:ForeignEquityHedge>0</d2p1:ForeignEquityHedge>
<d2p1:ForeignProperty>0</d2p1:ForeignProperty>
<d2p1:ForeignPropertyHedge>0</d2p1:ForeignPropertyHedge>
<d2p1:GlobalBonds>0</d2p1:GlobalBonds>
<d2p1:GlobalCash>0</d2p1:GlobalCash>
<d2p1:GlobalEmergingMarketBonds>0</d2p1:GlobalEmergingMarketBonds>
<d2p1:GlobalEmergingMarketEquity>0</d2p1:GlobalEmergingMarketEquity>
<d2p1:GlobalEquity>0</d2p1:GlobalEquity>
<d2p1:GlobalEquitySmallCapStocks>0</d2p1:GlobalEquitySmallCapStocks>
<d2p1:GlobalHedgeFunds>0</d2p1:GlobalHedgeFunds>
<d2p1:GlobalHighYield>0</d2p1:GlobalHighYield>
<d2p1:GlobalIncomeOpportunities>0</d2p1:GlobalIncomeOpportunities>
<d2p1:GlobalInvestmentGrade>0</d2p1:GlobalInvestmentGrade>
<d2p1:GlobalProperty>0</d2p1:GlobalProperty>
<d2p1:ListedInfrastructure>0</d2p1:ListedInfrastructure>
<d2p1:ListedPrivateEquity>0</d2p1:ListedPrivateEquity>
<d2p1:LocalBonds>0</d2p1:LocalBonds>
<d2p1:LocalBondsHedge>0</d2p1:LocalBondsHedge>
<d2p1:LocalCash>0</d2p1:LocalCash>
<d2p1:LocalCredit>0</d2p1:LocalCredit>
<d2p1:LocalEquity>0</d2p1:LocalEquity>
<d2p1:LocalEquityHedge>0</d2p1:LocalEquityHedge>
<d2p1:LocalInfrastructure>0</d2p1:LocalInfrastructure>
<d2p1:LocalProperty>0</d2p1:LocalProperty>
<d2p1:LocalPropertyHedge>0</d2p1:LocalPropertyHedge>
</AssetAllocation>
<ContributionCashFlowResponse>
<Incomes xmlns:d3p1="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel.Types">
<d3p1:IncomeView>
<d3p1:Income>0</d3p1:Income>
<d3p1:Year>0</d3p1:Year>
</d3p1:IncomeView>
</Incomes>
</ContributionCashFlowResponse>
<EndDate>0</EndDate>
<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>
<GetIncomeCashFlowRequest>
<AdhocCashFlow1>0</AdhocCashFlow1>
<AdhocCashFlow2>0</AdhocCashFlow2>
<AdhocCashFlow3>0</AdhocCashFlow3>
<AdhocCashFlowAge1>0</AdhocCashFlowAge1>
<AdhocCashFlowAge2>0</AdhocCashFlowAge2>
<AdhocCashFlowAge3>0</AdhocCashFlowAge3>
<ApplySmile>false</ApplySmile>
<CurrentAge>0</CurrentAge>
<HasAdhocCashFlow>false</HasAdhocCashFlow>
<Income>0</Income>
<IncomeGrowth>0</IncomeGrowth>
<IncomeGrowthFrequency>0</IncomeGrowthFrequency>
<IncomeIncludeZeroIncomeYears>false</IncomeIncludeZeroIncomeYears>
<IncomeLabel>String</IncomeLabel>
<IncomeToLast>0</IncomeToLast>
<KeyIndex>0</KeyIndex>
<PayoutFrequency>0</PayoutFrequency>
<SmilePercentages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfintdecimal>
<d3p1:Key>0</d3p1:Key>
<d3p1:Value>0</d3p1:Value>
</d3p1:KeyValueOfintdecimal>
</SmilePercentages>
<StartYear>0</StartYear>
<TaxRate>0</TaxRate>
</GetIncomeCashFlowRequest>
<IncludeMinMaxReturns>false</IncludeMinMaxReturns>
<IncomeCashFlowResponse>
<Incomes xmlns:d3p1="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel.Types">
<d3p1:IncomeView>
<d3p1:Income>0</d3p1:Income>
<d3p1:Year>0</d3p1:Year>
</d3p1:IncomeView>
</Incomes>
<IndividualIncomes>
<GetIncomeCashFlowResponse>
<Incomes xmlns:d5p1="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel.Types">
<d5p1:IncomeView>
<d5p1:Income>0</d5p1:Income>
<d5p1:Year>0</d5p1:Year>
</d5p1:IncomeView>
</Incomes>
<IndividualIncomes>
<GetIncomeCashFlowResponse>
<Incomes xmlns:d7p1="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel.Types">
<d7p1:IncomeView>
<d7p1:Income>0</d7p1:Income>
<d7p1:Year>0</d7p1:Year>
</d7p1:IncomeView>
</Incomes>
<IndividualIncomes>
<GetIncomeCashFlowResponse i:nil="true" />
</IndividualIncomes>
</GetIncomeCashFlowResponse>
</IndividualIncomes>
</GetIncomeCashFlowResponse>
</IndividualIncomes>
</IncomeCashFlowResponse>
<Lumpsum>0</Lumpsum>
<OtherCharges>0</OtherCharges>
<PlatformFee>0</PlatformFee>
<Rebalance>0</Rebalance>
<RollingReturnsPeriod>0</RollingReturnsPeriod>
<StartDate>0</StartDate>
<Tic>0</Tic>
</GetHistoricalCashFlow>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetHistoricalCashFlowResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
<AnnualReturns>
<HistoricalReturn>
<EndDate>String</EndDate>
<Period>String</Period>
<PeriodType>String</PeriodType>
<Return>0</Return>
<SectorReturn>0</SectorReturn>
<StartDate>String</StartDate>
</HistoricalReturn>
</AnnualReturns>
<Drawdown>
<HistoricalReturn>
<EndDate>String</EndDate>
<Period>String</Period>
<PeriodType>String</PeriodType>
<Return>0</Return>
<SectorReturn>0</SectorReturn>
<StartDate>String</StartDate>
</HistoricalReturn>
</Drawdown>
<HistoricalBalances>
<AaBalanceView>
<Africa>0</Africa>
<Balance>0</Balance>
<Commodity>0</Commodity>
<Date>String</Date>
<ForeignBonds>0</ForeignBonds>
<ForeignBondsHedge>0</ForeignBondsHedge>
<ForeignCash>0</ForeignCash>
<ForeignEquity>0</ForeignEquity>
<ForeignEquityHedge>0</ForeignEquityHedge>
<ForeignProperty>0</ForeignProperty>
<ForeignPropertyHedge>0</ForeignPropertyHedge>
<Income>0</Income>
<IncomeAnnualisedPercent>0</IncomeAnnualisedPercent>
<IndexedBalance>0</IndexedBalance>
<LocalBonds>0</LocalBonds>
<LocalBondsHedge>0</LocalBondsHedge>
<LocalCash>0</LocalCash>
<LocalEquity>0</LocalEquity>
<LocalEquityHedge>0</LocalEquityHedge>
<LocalProperty>0</LocalProperty>
<LocalPropertyHedge>0</LocalPropertyHedge>
<MonthIndex>0</MonthIndex>
<StartDate>String</StartDate>
<TotalReturn>0</TotalReturn>
<YearIndex>0</YearIndex>
</AaBalanceView>
</HistoricalBalances>
<HistoricalStats>
<BestYear>0</BestYear>
<Date>String</Date>
<InitialBalance>0</InitialBalance>
<MaxDrawdown>0</MaxDrawdown>
<SharpeRatio>0</SharpeRatio>
<Sortino>0</Sortino>
<StDev>0</StDev>
<TotalContributions>0</TotalContributions>
<TotalWithdrawals>0</TotalWithdrawals>
<WorstYear>0</WorstYear>
</HistoricalStats>
<MinMax10YearReturns>
<AverageReturn>0</AverageReturn>
<Date>String</Date>
<MaxReturn>0</MaxReturn>
<MaxReturnEndDate>String</MaxReturnEndDate>
<MaxReturnStartDate>String</MaxReturnStartDate>
<MinReturn>0</MinReturn>
<MinReturnEndDate>String</MinReturnEndDate>
<MinReturnStartDate>String</MinReturnStartDate>
<Months>0</Months>
</MinMax10YearReturns>
<MinMax15YearReturns>
<AverageReturn>0</AverageReturn>
<Date>String</Date>
<MaxReturn>0</MaxReturn>
<MaxReturnEndDate>String</MaxReturnEndDate>
<MaxReturnStartDate>String</MaxReturnStartDate>
<MinReturn>0</MinReturn>
<MinReturnEndDate>String</MinReturnEndDate>
<MinReturnStartDate>String</MinReturnStartDate>
<Months>0</Months>
</MinMax15YearReturns>
<MinMax1YearReturns>
<AverageReturn>0</AverageReturn>
<Date>String</Date>
<MaxReturn>0</MaxReturn>
<MaxReturnEndDate>String</MaxReturnEndDate>
<MaxReturnStartDate>String</MaxReturnStartDate>
<MinReturn>0</MinReturn>
<MinReturnEndDate>String</MinReturnEndDate>
<MinReturnStartDate>String</MinReturnStartDate>
<Months>0</Months>
</MinMax1YearReturns>
<MinMax20YearReturns>
<AverageReturn>0</AverageReturn>
<Date>String</Date>
<MaxReturn>0</MaxReturn>
<MaxReturnEndDate>String</MaxReturnEndDate>
<MaxReturnStartDate>String</MaxReturnStartDate>
<MinReturn>0</MinReturn>
<MinReturnEndDate>String</MinReturnEndDate>
<MinReturnStartDate>String</MinReturnStartDate>
<Months>0</Months>
</MinMax20YearReturns>
<MinMax25YearReturns>
<AverageReturn>0</AverageReturn>
<Date>String</Date>
<MaxReturn>0</MaxReturn>
<MaxReturnEndDate>String</MaxReturnEndDate>
<MaxReturnStartDate>String</MaxReturnStartDate>
<MinReturn>0</MinReturn>
<MinReturnEndDate>String</MinReturnEndDate>
<MinReturnStartDate>String</MinReturnStartDate>
<Months>0</Months>
</MinMax25YearReturns>
<MinMax30YearReturns>
<AverageReturn>0</AverageReturn>
<Date>String</Date>
<MaxReturn>0</MaxReturn>
<MaxReturnEndDate>String</MaxReturnEndDate>
<MaxReturnStartDate>String</MaxReturnStartDate>
<MinReturn>0</MinReturn>
<MinReturnEndDate>String</MinReturnEndDate>
<MinReturnStartDate>String</MinReturnStartDate>
<Months>0</Months>
</MinMax30YearReturns>
<MinMax35YearReturns>
<AverageReturn>0</AverageReturn>
<Date>String</Date>
<MaxReturn>0</MaxReturn>
<MaxReturnEndDate>String</MaxReturnEndDate>
<MaxReturnStartDate>String</MaxReturnStartDate>
<MinReturn>0</MinReturn>
<MinReturnEndDate>String</MinReturnEndDate>
<MinReturnStartDate>String</MinReturnStartDate>
<Months>0</Months>
</MinMax35YearReturns>
<MinMax40YearReturns>
<AverageReturn>0</AverageReturn>
<Date>String</Date>
<MaxReturn>0</MaxReturn>
<MaxReturnEndDate>String</MaxReturnEndDate>
<MaxReturnStartDate>String</MaxReturnStartDate>
<MinReturn>0</MinReturn>
<MinReturnEndDate>String</MinReturnEndDate>
<MinReturnStartDate>String</MinReturnStartDate>
<Months>0</Months>
</MinMax40YearReturns>
<MinMax5YearReturns>
<AverageReturn>0</AverageReturn>
<Date>String</Date>
<MaxReturn>0</MaxReturn>
<MaxReturnEndDate>String</MaxReturnEndDate>
<MaxReturnStartDate>String</MaxReturnStartDate>
<MinReturn>0</MinReturn>
<MinReturnEndDate>String</MinReturnEndDate>
<MinReturnStartDate>String</MinReturnStartDate>
<Months>0</Months>
</MinMax5YearReturns>
<MonthlyReturns>
<HistoricalReturn>
<EndDate>String</EndDate>
<Period>String</Period>
<PeriodType>String</PeriodType>
<Return>0</Return>
<SectorReturn>0</SectorReturn>
<StartDate>String</StartDate>
</HistoricalReturn>
</MonthlyReturns>
<RollingReturns>
<HistoricalReturn>
<EndDate>String</EndDate>
<Period>String</Period>
<PeriodType>String</PeriodType>
<Return>0</Return>
<SectorReturn>0</SectorReturn>
<StartDate>String</StartDate>
</HistoricalReturn>
</RollingReturns>
<StressPeriods>
<DrawdownReturn>
<Description>String</Description>
<EndDate>String</EndDate>
<Length>0</Length>
<RecoveredBy>String</RecoveredBy>
<RecoveryTime>0</RecoveryTime>
<Return>0</Return>
<StartDate>String</StartDate>
<UnderwaterPeriod>0</UnderwaterPeriod>
</DrawdownReturn>
</StressPeriods>
</GetHistoricalCashFlowResponse>