Platform API

GetSettings

The following routes are available for this service:
All Verbs	/api/settings


export class SettingModel
{
    public SettingId: string;
    public SettingName: string;
    public SettingValue: string;

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

// @ApiResponse(Description="List of settings")
export class GetSettingsResponse
{
    public Settings: SettingModel[];
    public ResponseStatus: ResponseStatus;

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

export class GetSettings
{
    public SettingIds: string[];

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

TypeScript GetSettings DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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