JiwaAPI

<back to all web services

SY_SysValuesQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/SY_SysValuesRetrieves a list of system settings.
SY_SysValuesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
SectionquerystringNo
SectionStartsWithquerystringNo
SectionEndsWithquerystringNo
SectionContainsquerystringNo
SectionLikequerystringNo
SectionBetweenquerystring[]No
SectionInquerystring[]No
IDKeyquerystringNo
IDKeyStartsWithquerystringNo
IDKeyEndsWithquerystringNo
IDKeyContainsquerystringNo
IDKeyLikequerystringNo
IDKeyBetweenquerystring[]No
IDKeyInquerystring[]No
ContentsquerystringNo
ContentsStartsWithquerystringNo
ContentsEndsWithquerystringNo
ContentsContainsquerystringNo
ContentsLikequerystringNo
ContentsBetweenquerystring[]No
ContentsInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
CellTypequeryshort?No
CellTypeGreaterThanOrEqualToqueryshort?No
CellTypeGreaterThanqueryshort?No
CellTypeLessThanqueryshort?No
CellTypeLessThanOrEqualToqueryshort?No
CellTypeNotEqualToqueryshort?No
CellTypeBetweenqueryshort[]No
CellTypeInqueryshort[]No
DisplayOrderqueryint?No
DisplayOrderGreaterThanOrEqualToqueryint?No
DisplayOrderGreaterThanqueryint?No
DisplayOrderLessThanqueryint?No
DisplayOrderLessThanOrEqualToqueryint?No
DisplayOrderNotEqualToqueryint?No
DisplayOrderBetweenqueryint[]No
DisplayOrderInqueryint[]No
SectionCaptionquerystringNo
SectionCaptionStartsWithquerystringNo
SectionCaptionEndsWithquerystringNo
SectionCaptionContainsquerystringNo
SectionCaptionLikequerystringNo
SectionCaptionBetweenquerystring[]No
SectionCaptionInquerystring[]No
ReadOnlyquerybool?No
ScriptFormatCellquerystringNo
ScriptFormatCellStartsWithquerystringNo
ScriptFormatCellEndsWithquerystringNo
ScriptFormatCellContainsquerystringNo
ScriptFormatCellLikequerystringNo
ScriptFormatCellBetweenquerystring[]No
ScriptFormatCellInquerystring[]No
ScriptButtonClickedquerystringNo
ScriptButtonClickedStartsWithquerystringNo
ScriptButtonClickedEndsWithquerystringNo
ScriptButtonClickedContainsquerystringNo
ScriptButtonClickedLikequerystringNo
ScriptButtonClickedBetweenquerystring[]No
ScriptButtonClickedInquerystring[]No
ScriptReadDataquerystringNo
ScriptReadDataStartsWithquerystringNo
ScriptReadDataEndsWithquerystringNo
ScriptReadDataContainsquerystringNo
ScriptReadDataLikequerystringNo
ScriptReadDataBetweenquerystring[]No
ScriptReadDataInquerystring[]No
GridHandlerCodequerystringNo
GridHandlerCodeStartsWithquerystringNo
GridHandlerCodeEndsWithquerystringNo
GridHandlerCodeContainsquerystringNo
GridHandlerCodeLikequerystringNo
GridHandlerCodeBetweenquerystring[]No
GridHandlerCodeInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_SysValues Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
SectionformstringNo
IDKeyformstringNo
ContentsformstringNo
DescriptionformstringNo
CellTypeformshortNo
DisplayOrderformintNo
SectionCaptionformstringNo
ReadOnlyformboolNo
ScriptFormatCellformstringNo
ScriptButtonClickedformstringNo
ScriptReadDataformstringNo
GridHandlerCodeformstringNo
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.

GET /Queries/SY_SysValues HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"RecID":"String","Section":"String","IDKey":"String","Contents":"String","Description":"String","SectionCaption":"String","ScriptFormatCell":"String","ScriptButtonClicked":"String","ScriptReadData":"String","GridHandlerCode":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}