Platform API

<back to all web services

GetSettings

The following routes are available for this service:
All Verbs/api/settings
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class GetSettings
    {
        public ArrayList<UUID> SettingIds = null;
        
        public ArrayList<UUID> getSettingIds() { return SettingIds; }
        public GetSettings setSettingIds(ArrayList<UUID> value) { this.SettingIds = value; return this; }
    }

    @ApiResponse(Description="List of settings")
    public static class GetSettingsResponse
    {
        public ArrayList<SettingModel> Settings = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<SettingModel> getSettings() { return Settings; }
        public GetSettingsResponse setSettings(ArrayList<SettingModel> value) { this.Settings = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetSettingsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class SettingModel
    {
        public UUID SettingId = null;
        public String SettingName = null;
        public String SettingValue = null;
        
        public UUID getSettingId() { return SettingId; }
        public SettingModel setSettingId(UUID value) { this.SettingId = value; return this; }
        public String getSettingName() { return SettingName; }
        public SettingModel setSettingName(String value) { this.SettingName = value; return this; }
        public String getSettingValue() { return SettingValue; }
        public SettingModel setSettingValue(String value) { this.SettingValue = value; return this; }
    }

}

Java 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"}}}