Platform API

<back to all web services

GetSettingsForAppliance

Returns system settings for a specified appliance.

Requires Authentication 
"use strict";
export class GetSettingsForAppliance {
    /** @param {{ApplianceId?:string,SettingIds?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The appliance ID to return settings for. */
    ApplianceId;
    /**
     * @type {string[]}
     * @description A list of the setting Id's that are to be retrieved. */
    SettingIds = [];
}

JavaScript GetSettingsForAppliance 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 /csv/reply/GetSettingsForAppliance HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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