PortfolioLinkApi

<back to all web services

UpdatePartnerSettings

Requires Authentication
The following routes are available for this service:
All Verbs/settings/update
UpdatePartnerSettings Parameters:
NameParameterData TypeRequiredDescription
PartnerIdqueryintNo
PartnerLogoUrlquerystringNo
PartnerBackgroundTypequerystringNo
PartnerBackgroundUrlquerystringNo
HellosignapikeyquerystringNo
ExpectedInflationRatequerydecimalNo
WithdrawalIncomeGrowthRatequerydecimalNo
UpdatePartnerSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
PartnerIdformintNo
PartnerLogoUrlformstringNo
PartnerBackgroundTypeformstringNo
PartnerBackgroundUrlformstringNo
HellosignapikeyformstringNo
ExpectedInflationRateformdecimalNo
WithdrawalIncomeGrowthRateformdecimalNo

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

<UpdatePartnerSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <ExpectedInflationRate>0</ExpectedInflationRate>
  <Hellosignapikey>String</Hellosignapikey>
  <PartnerBackgroundType>String</PartnerBackgroundType>
  <PartnerBackgroundUrl>String</PartnerBackgroundUrl>
  <PartnerId>0</PartnerId>
  <PartnerLogoUrl>String</PartnerLogoUrl>
  <WithdrawalIncomeGrowthRate>0</WithdrawalIncomeGrowthRate>
</UpdatePartnerSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdatePartnerSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <ExpectedInflationRate>0</ExpectedInflationRate>
  <Hellosignapikey>String</Hellosignapikey>
  <PartnerBackgroundType>String</PartnerBackgroundType>
  <PartnerBackgroundUrl>String</PartnerBackgroundUrl>
  <PartnerId>0</PartnerId>
  <PartnerLogoUrl>String</PartnerLogoUrl>
  <WithdrawalIncomeGrowthRate>0</WithdrawalIncomeGrowthRate>
</UpdatePartnerSettingsResponse>