PortfolioLinkApi

<back to all web services

GetPartnerSettings

Requires Authentication
The following routes are available for this service:
All Verbs/settings
GetPartnerSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
PartnerIdformintNo
PartnerLogoUrlformstringNo
PartnerBackgroundTypeformstringNo
PartnerBackgroundUrlformstringNo
HellosignapikeyformstringNo
AdvisorFeeformdecimalNo
OtherChargesformdecimalNo
PlatformFeeformdecimalNo
ExpectedInflationRateformdecimalNo
WithdrawalIncomeGrowthRateformdecimalNo
PartnerDefaultSettingsformPartnerDefaultSettingsNo
PartnerContactDetailsformPartnerContactDetailsNo
PartnerDefaultSettings Parameters:
NameParameterData TypeRequiredDescription
SettingsIdformintNo
PartnerIdformintNo
PartnerNameformstringNo
AaTypeformstringNo
ThemeIdformintNo
InitialFeeformdecimalNo
AdvisorFeeformdecimalNo
PlatformFeeformdecimalNo
MoreLikelyZScoreformdecimalNo
LessLikelyZScoreformdecimalNo
ShowLowestProjectedOutcomeformboolNo
IsFundAlphaEqualToFeesformboolNo
ShowAdvisoryFeesformboolNo
ShowCashflowTableformboolNo
XAxisLabelformstringNo
AppearanceSettingsformAppearanceSettingsNo
AppearanceSettings Parameters:
NameParameterData TypeRequiredDescription
AppearanceSchemaformAppearanceSchemaNo
ProjectedComponentNameformstringNo
ShowMedianOutcomeformboolNo
MedianLineColorformstringNo
BottomScenarioLineColorformstringNo
ShowLowestProjectedOutcomeformboolNo
AppearanceSchema Parameters:
NameParameterData TypeRequiredDescription
FontColorformstringNo
AxisColorformstringNo
AxisGridColorformstringNo
GraphColorformstringNo
GraphColorOpacityformdoubleNo
GraphColorRange2formstringNo
GraphColorOpacity2formdoubleNo
AverageLineColorformstringNo
BarColor1formstringNo
BarColor2formstringNo
LogoHeightformstringNo
LogoUrlformstringNo
LogoBackgroundformstringNo
TopBarBackgroundformstringNo
TopBarFontColorformstringNo
H2ColorformstringNo
LinkColorformstringNo
ProposalBackgroundUrlformstringNo
ProposalBackgroundUrl2formstringNo
ProposalBackgroundUrl3formstringNo
ProposalBackgroundUrl4formstringNo
PartnerContactDetails Parameters:
NameParameterData TypeRequiredDescription
WebsiteformstringNo
EmailformstringNo
TelephoneformstringNo
FaxformstringNo
AddressLine1formstringNo
AddressLine2formstringNo
AddressLine3formstringNo
AddressLine4formstringNo

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

<GetPartnerSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPartnerSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <AdvisorFee>0</AdvisorFee>
  <ExpectedInflationRate>0</ExpectedInflationRate>
  <Hellosignapikey>String</Hellosignapikey>
  <OtherCharges>0</OtherCharges>
  <PartnerBackgroundType>String</PartnerBackgroundType>
  <PartnerBackgroundUrl>String</PartnerBackgroundUrl>
  <PartnerContactDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharedTypes">
    <d2p1:AddressLine1>String</d2p1:AddressLine1>
    <d2p1:AddressLine2>String</d2p1:AddressLine2>
    <d2p1:AddressLine3>String</d2p1:AddressLine3>
    <d2p1:AddressLine4>String</d2p1:AddressLine4>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:Fax>String</d2p1:Fax>
    <d2p1:Telephone>String</d2p1:Telephone>
    <d2p1:Website>String</d2p1:Website>
  </PartnerContactDetails>
  <PartnerDefaultSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharedTypes">
    <d2p1:AaType>String</d2p1:AaType>
    <d2p1:AdvisorFee>0</d2p1:AdvisorFee>
    <d2p1:AppearanceSettings>
      <d2p1:AppearanceSchema>
        <d2p1:AverageLineColor>String</d2p1:AverageLineColor>
        <d2p1:AxisColor>String</d2p1:AxisColor>
        <d2p1:AxisGridColor>String</d2p1:AxisGridColor>
        <d2p1:BarColor1>String</d2p1:BarColor1>
        <d2p1:BarColor2>String</d2p1:BarColor2>
        <d2p1:FontColor>String</d2p1:FontColor>
        <d2p1:GraphColor>String</d2p1:GraphColor>
        <d2p1:GraphColorOpacity>0</d2p1:GraphColorOpacity>
        <d2p1:GraphColorOpacity2>0</d2p1:GraphColorOpacity2>
        <d2p1:GraphColorRange2>String</d2p1:GraphColorRange2>
        <d2p1:H2Color>String</d2p1:H2Color>
        <d2p1:LinkColor>String</d2p1:LinkColor>
        <d2p1:LogoBackground>String</d2p1:LogoBackground>
        <d2p1:LogoHeight>String</d2p1:LogoHeight>
        <d2p1:LogoUrl>String</d2p1:LogoUrl>
        <d2p1:ProposalBackgroundUrl>String</d2p1:ProposalBackgroundUrl>
        <d2p1:ProposalBackgroundUrl2>String</d2p1:ProposalBackgroundUrl2>
        <d2p1:ProposalBackgroundUrl3>String</d2p1:ProposalBackgroundUrl3>
        <d2p1:ProposalBackgroundUrl4>String</d2p1:ProposalBackgroundUrl4>
        <d2p1:TopBarBackground>String</d2p1:TopBarBackground>
        <d2p1:TopBarFontColor>String</d2p1:TopBarFontColor>
      </d2p1:AppearanceSchema>
      <d2p1:BottomScenarioLineColor>String</d2p1:BottomScenarioLineColor>
      <d2p1:MedianLineColor>String</d2p1:MedianLineColor>
      <d2p1:ProjectedComponentName>String</d2p1:ProjectedComponentName>
      <d2p1:ShowLowestProjectedOutcome>false</d2p1:ShowLowestProjectedOutcome>
      <d2p1:ShowMedianOutcome>false</d2p1:ShowMedianOutcome>
    </d2p1:AppearanceSettings>
    <d2p1:InitialFee>0</d2p1:InitialFee>
    <d2p1:IsFundAlphaEqualToFees>false</d2p1:IsFundAlphaEqualToFees>
    <d2p1:LessLikelyZScore>0</d2p1:LessLikelyZScore>
    <d2p1:MoreLikelyZScore>0</d2p1:MoreLikelyZScore>
    <d2p1:PartnerId>0</d2p1:PartnerId>
    <d2p1:PartnerName>String</d2p1:PartnerName>
    <d2p1:PlatformFee>0</d2p1:PlatformFee>
    <d2p1:SettingsId>0</d2p1:SettingsId>
    <d2p1:ShowAdvisoryFees>false</d2p1:ShowAdvisoryFees>
    <d2p1:ShowCashflowTable>false</d2p1:ShowCashflowTable>
    <d2p1:ShowLowestProjectedOutcome>false</d2p1:ShowLowestProjectedOutcome>
    <d2p1:ThemeId>0</d2p1:ThemeId>
    <d2p1:XAxisLabel>String</d2p1:XAxisLabel>
  </PartnerDefaultSettings>
  <PartnerId>0</PartnerId>
  <PartnerLogoUrl>String</PartnerLogoUrl>
  <PlatformFee>0</PlatformFee>
  <WithdrawalIncomeGrowthRate>0</WithdrawalIncomeGrowthRate>
</GetPartnerSettingsResponse>