JiwaAPI

<back to all web services

SY_PluginSystemSettingsQuery

Requires Authentication
SY_PluginSystemSettingsQuery Parameters:
NameParameterData TypeRequiredDescription
SY_Plugin_RecIDqueryGuid?No
SY_Plugin_RecIDInqueryGuid[]No
SY_Sysvalues_RecIDquerystringNo
SY_Sysvalues_RecIDStartsWithquerystringNo
SY_Sysvalues_RecIDEndsWithquerystringNo
SY_Sysvalues_RecIDContainsquerystringNo
SY_Sysvalues_RecIDLikequerystringNo
SY_Sysvalues_RecIDBetweenquerystring[]No
SY_Sysvalues_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_PluginSystemSettings Parameters:
NameParameterData TypeRequiredDescription
SY_Plugin_RecIDformGuidNo
SY_Sysvalues_RecIDformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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 /json/reply/SY_PluginSystemSettingsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SY_Plugin_RecID":"00000000000000000000000000000000","SY_Plugin_RecIDIn":["00000000-0000-0000-0000-000000000000"],"SY_Sysvalues_RecID":"String","SY_Sysvalues_RecIDStartsWith":"String","SY_Sysvalues_RecIDEndsWith":"String","SY_Sysvalues_RecIDContains":"String","SY_Sysvalues_RecIDLike":"String","SY_Sysvalues_RecIDBetween":["String"],"SY_Sysvalues_RecIDIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"SY_Sysvalues_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}