Platform API

<back to all web services

GetSettings

The following routes are available for this service:
All Verbs/api/settings
"use strict";
export class SettingModel {
    /** @param {{SettingId?:string,SettingName?:string,SettingValue?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SettingId;
    /** @type {string} */
    SettingName;
    /** @type {string} */
    SettingValue;
}
export class GetSettingsResponse {
    /** @param {{Settings?:SettingModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SettingModel[]} */
    Settings;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetSettings {
    /** @param {{SettingIds?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    SettingIds;
}

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

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

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