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

export class SettingModel
{
    public SettingId: string;
    public SettingName: string;
    public SettingValue: string;

    public constructor(init?: Partial<SettingModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List of settings")
export class GetSettingsResponse
{
    public Settings: SettingModel[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetSettingsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get all theme settings for the appliance and current context including title, colours and footer settings */
// @Api(Description="Get all theme settings for the appliance and current context including title, colours and footer settings")
export class GetThemeSettings implements IPublicServiceModel
{
    /** @description Appliance to retrieve theme settings for */
    // @ApiMember(Description="Appliance to retrieve theme settings for", Name="ApplianceId")
    public ApplianceId: string;

    public SubdomainName: string;

    public constructor(init?: Partial<GetThemeSettings>) { (Object as any).assign(this, init); }
}

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