PortfolioLinkApi

<back to all web services

GetThemesM

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/management/themes
GetThemesM Parameters:
NameParameterData TypeRequiredDescription
PartnerIdqueryintNo
SearchTextquerystringNo
GetThemesResponseM Parameters:
NameParameterData TypeRequiredDescription
ResultformList<Theme>No
Theme Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
ThemeComponentNameformstringNo
AppNameformstringNo
PartnerIdformintNo
IsDefaultformboolNo
PartnerNameformstringNo
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

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

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

<GetThemesResponseM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharedTypes">
    <d2p1:Theme>
      <d2p1:AppName>String</d2p1:AppName>
      <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:Id>0</d2p1:Id>
      <d2p1:IsDefault>false</d2p1:IsDefault>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PartnerId>0</d2p1:PartnerId>
      <d2p1:PartnerName>String</d2p1:PartnerName>
      <d2p1:ThemeComponentName>String</d2p1:ThemeComponentName>
    </d2p1:Theme>
  </Result>
</GetThemesResponseM>