Platform API

<back to all web services

GetSettingsForAppliance

Returns system settings for a specified appliance.

Requires Authentication

/** @description Returns system settings for a specified appliance. */
// @Api(Description="Returns system settings for a specified appliance.")
export class GetSettingsForAppliance
{
    /** @description The appliance ID to return settings for. */
    // @ApiMember(DataType="Guid", Description="The appliance ID to return settings for.", IsRequired=true, Name="ApplianceId", ParameterType="query")
    public ApplianceId: string;

    /** @description A list of the setting Id's that are to be retrieved. */
    // @ApiMember(DataType="Guid", Description="A list of the setting Id's that are to be retrieved.", IsRequired=true, Name="SettingIds", ParameterType="query")
    public SettingIds: string[] = [];

    public constructor(init?: Partial<GetSettingsForAppliance>) { (Object as any).assign(this, init); }
}

TypeScript GetSettingsForAppliance DTOs

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

HTTP + JSV

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

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

{
	SettingIds: 
	[
		00000000-0000-0000-0000-000000000000
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		SettingName: String,
		SettingValue: String
	}
]