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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettingModel:
    setting_id: Optional[str] = None
    setting_name: Optional[str] = None
    setting_value: Optional[str] = None


# @ApiResponse(Description="List of settings")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSettingsResponse:
    settings: Optional[List[SettingModel]] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Get all theme settings for the appliance and current context including title, colours and footer settings")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetThemeSettings(IPublicServiceModel):
    """
    Get all theme settings for the appliance and current context including title, colours and footer settings
    """

    # @ApiMember(Description="Appliance to retrieve theme settings for", Name="ApplianceId")
    appliance_id: Optional[str] = None
    """
    Appliance to retrieve theme settings for
    """


    subdomain_name: Optional[str] = None

Python GetThemeSettings DTOs

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"}}}