Platform API

<back to all web services

GetSettingsForAppliance

Returns system settings for a specified appliance.

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Returns system settings for a specified appliance.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSettingsForAppliance:
    """
    Returns system settings for a specified appliance.
    """

    # @ApiMember(DataType="Guid", Description="The appliance ID to return settings for.", IsRequired=true, Name="ApplianceId", ParameterType="query")
    appliance_id: Optional[str] = None
    """
    The appliance ID to return settings for.
    """


    # @ApiMember(DataType="Guid", Description="A list of the setting Id's that are to be retrieved.", IsRequired=true, Name="SettingIds", ParameterType="query")
    setting_ids: List[str] = field(default_factory=list)
    """
    A list of the setting Id's that are to be retrieved.
    """

Python 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"}]