Platform API

<back to all web services

GetThemeSettings

Get all theme settings for the appliance and current context including title, colours and footer settings

The following routes are available for this service:
All Verbs/api/themesettings
GetThemeSettings Parameters:
NameParameterData TypeRequiredDescription
ApplianceIdqueryGuidNoAppliance to retrieve theme settings for
SubdomainNamequerystringNo
GetSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
SettingsformList<SettingModel>No
ResponseStatusformResponseStatusNo
SettingModel Parameters:
NameParameterData TypeRequiredDescription
SettingIdformGuidNo
SettingNameformstringNo
SettingValueformstringNo

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 /api/themesettings HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ApplianceId":"00000000-0000-0000-0000-000000000000","SubdomainName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Settings":[{"SettingId":"00000000-0000-0000-0000-000000000000","SettingName":"String","SettingValue":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}