Platform API

<back to all web services

GetSettingsForAppliance

Returns system settings for a specified appliance.

Requires Authentication
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

    ///<summary>
    ///Returns system settings for a specified appliance.
    ///</summary>
    [<Api(Description="Returns system settings for a specified appliance.")>]
    [<AllowNullLiteral>]
    type GetSettingsForAppliance() = 
        ///<summary>
        ///The appliance ID to return settings for.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The appliance ID to return settings for.", IsRequired=true, Name="ApplianceId", ParameterType="query")>]
        member val ApplianceId:Guid = new Guid() with get,set

        ///<summary>
        ///A list of the setting Id's that are to be retrieved.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="A list of the setting Id's that are to be retrieved.", IsRequired=true, Name="SettingIds", ParameterType="query")>]
        member val SettingIds:ResizeArray<Guid> = null with get,set

F# GetSettingsForAppliance DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/GetSettingsForAppliance HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApplianceId":"00000000-0000-0000-0000-000000000000","SettingIds":["00000000-0000-0000-0000-000000000000"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"SettingId":"00000000-0000-0000-0000-000000000000","SettingName":"String","SettingValue":"String"}]