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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SettingModel() = 
        member val SettingId:Guid = new Guid() with get,set
        member val SettingName:String = null with get,set
        member val SettingValue:String = null with get,set

    [<ApiResponse(Description="List of settings")>]
    [<AllowNullLiteral>]
    type GetSettingsResponse() = 
        member val Settings:ResizeArray<SettingModel> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get all theme settings for the appliance and current context including title, colours and footer settings
    ///</summary>
    [<Api(Description="Get all theme settings for the appliance and current context including title, colours and footer settings")>]
    [<AllowNullLiteral>]
    type GetThemeSettings() = 
        ///<summary>
        ///Appliance to retrieve theme settings for
        ///</summary>
        [<ApiMember(Description="Appliance to retrieve theme settings for", Name="ApplianceId")>]
        member val ApplianceId:Guid = new Guid() with get,set

        member val SubdomainName:String = null with get,set

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