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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"partnerId":0,"searchText":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":[{"id":0,"name":"String","themeComponentName":"String","appName":"String","partnerId":0,"isDefault":false,"partnerName":"String","appearanceSettings":{"appearanceSchema":{"fontColor":"String","axisColor":"String","axisGridColor":"String","graphColor":"String","graphColorOpacity":0,"graphColorRange2":"String","graphColorOpacity2":0,"averageLineColor":"String","barColor1":"String","barColor2":"String","logoHeight":"String","logoUrl":"String","logoBackground":"String","topBarBackground":"String","topBarFontColor":"String","h2Color":"String","linkColor":"String","proposalBackgroundUrl":"String","proposalBackgroundUrl2":"String","proposalBackgroundUrl3":"String","proposalBackgroundUrl4":"String"},"projectedComponentName":"String","showMedianOutcome":false,"medianLineColor":"String","bottomScenarioLineColor":"String","showLowestProjectedOutcome":false}}]}