Platform API

<back to all web services

GetSettings

The following routes are available for this service:
All Verbs/api/settings
GetSettings Parameters:
NameParameterData TypeRequiredDescription
SettingIdsqueryList<Guid>No
GetSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
SettingsformList<SettingModel>No
ResponseStatusformResponseStatusNo
SettingModel Parameters:
NameParameterData TypeRequiredDescription
SettingIdformGuidNo
SettingNameformstringNo
SettingValueformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"SettingIds":["00000000-0000-0000-0000-000000000000"]}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}