Platform API

<back to all web services

GetSettings

The following routes are available for this service:
All Verbs/api/settings
import Foundation
import ServiceStack

public class GetSettings : Codable
{
    public var settingIds:[String]

    required public init(){}
}

// @ApiResponse(Description="List of settings")
public class GetSettingsResponse : Codable
{
    public var settings:[SettingModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class SettingModel : Codable
{
    public var settingId:String
    public var settingName:String
    public var settingValue:String

    required public init(){}
}

Swift GetSettings DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/settings HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SettingIds":["00000000-0000-0000-0000-000000000000"]}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}