PortfolioLinkApi

<back to all web services

CreateOrUpdateRetirementGoal

Requires Authentication
The following routes are available for this service:
All Verbs/goals/retirement/create
CreateOrUpdateRetirementGoal Parameters:
NameParameterData TypeRequiredDescription
IdqueryintNo
ClientIdqueryintNo
GoalNamequerystringNo
LifeExpectancyAgequeryintNo
ExpectedInflationRatequerydoubleNo
CurrentSavingsquerydoubleNo
WithdrawalAmountquerydoubleNo
WithdrawalGrowthRatequerydoubleNo
CashReservequerydoubleNo
AddtionalSaPropertyquerydoubleNo
CreateGoalResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformintNo

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

<CreateOrUpdateRetirementGoal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <AddtionalSaProperty>0</AddtionalSaProperty>
  <CashReserve>0</CashReserve>
  <ClientId>0</ClientId>
  <CurrentSavings>0</CurrentSavings>
  <ExpectedInflationRate>0</ExpectedInflationRate>
  <GoalName>String</GoalName>
  <Id>0</Id>
  <LifeExpectancyAge>0</LifeExpectancyAge>
  <WithdrawalAmount>0</WithdrawalAmount>
  <WithdrawalGrowthRate>0</WithdrawalGrowthRate>
</CreateOrUpdateRetirementGoal>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateGoalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Success>0</Success>
</CreateGoalResponse>