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 'package:servicestack/servicestack.dart';

class SettingModel implements IConvertible
{
    String? SettingId;
    String? SettingName;
    String? SettingValue;

    SettingModel({this.SettingId,this.SettingName,this.SettingValue});
    SettingModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SettingId = json['SettingId'];
        SettingName = json['SettingName'];
        SettingValue = json['SettingValue'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SettingId': SettingId,
        'SettingName': SettingName,
        'SettingValue': SettingValue
    };

    getTypeName() => "SettingModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="List of settings")
class GetSettingsResponse implements IConvertible
{
    List<SettingModel>? Settings;
    ResponseStatus? ResponseStatus;

    GetSettingsResponse({this.Settings,this.ResponseStatus});
    GetSettingsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Settings = JsonConverters.fromJson(json['Settings'],'List<SettingModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Settings': JsonConverters.toJson(Settings,'List<SettingModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetSettingsResponse";
    TypeContext? context = _ctx;
}

/**
* 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")
class GetThemeSettings implements IPublicServiceModel, IConvertible
{
    /**
    * Appliance to retrieve theme settings for
    */
    // @ApiMember(Description="Appliance to retrieve theme settings for", Name="ApplianceId")
    String? ApplianceId;

    String? SubdomainName;

    GetThemeSettings({this.ApplianceId,this.SubdomainName});
    GetThemeSettings.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApplianceId = json['ApplianceId'];
        SubdomainName = json['SubdomainName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApplianceId': ApplianceId,
        'SubdomainName': SubdomainName
    };

    getTypeName() => "GetThemeSettings";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SettingModel': TypeInfo(TypeOf.Class, create:() => SettingModel()),
    'GetSettingsResponse': TypeInfo(TypeOf.Class, create:() => GetSettingsResponse()),
    'List<SettingModel>': TypeInfo(TypeOf.Class, create:() => <SettingModel>[]),
    'GetThemeSettings': TypeInfo(TypeOf.Class, create:() => GetThemeSettings()),
});

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