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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Subtle.Canvara.WebAPIModel.Models

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.Models

        Public Partial Class SettingModel
            Public Overridable Property SettingId As Guid
            Public Overridable Property SettingName As String
            Public Overridable Property SettingValue As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        <ApiResponse(Description:="List of settings")>
        Public Partial Class GetSettingsResponse
            Public Overridable Property Settings As List(Of SettingModel)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        '''<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")>
        Public Partial Class GetThemeSettings
            Implements IPublicServiceModel
            '''<Summary>
            '''Appliance to retrieve theme settings for
            '''</Summary>
            <ApiMember(Description:="Appliance to retrieve theme settings for", Name:="ApplianceId")>
            Public Overridable Property ApplianceId As Guid Implements IPublicServiceModel.ApplianceId

            Public Overridable Property SubdomainName As String Implements IPublicServiceModel.SubdomainName
        End Class
    End Namespace
End Namespace

VB.NET 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"}}}