JiwaAPI

<back to all web services

BR_CustomSettingQuery

Requires Authentication
BR_CustomSettingQuery Parameters:
NameParameterData TypeRequiredDescription
SettingIDquerystringNo
SettingIDStartsWithquerystringNo
SettingIDEndsWithquerystringNo
SettingIDContainsquerystringNo
SettingIDLikequerystringNo
SettingIDBetweenquerystring[]No
SettingIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
SettingDescriptionquerystringNo
SettingDescriptionStartsWithquerystringNo
SettingDescriptionEndsWithquerystringNo
SettingDescriptionContainsquerystringNo
SettingDescriptionLikequerystringNo
SettingDescriptionBetweenquerystring[]No
SettingDescriptionInquerystring[]No
SettingNamequerystringNo
SettingNameStartsWithquerystringNo
SettingNameEndsWithquerystringNo
SettingNameContainsquerystringNo
SettingNameLikequerystringNo
SettingNameBetweenquerystring[]No
SettingNameInquerystring[]No
DisplayOrderquerydecimal?No
DisplayOrderGreaterThanOrEqualToquerydecimal?No
DisplayOrderGreaterThanquerydecimal?No
DisplayOrderLessThanquerydecimal?No
DisplayOrderLessThanOrEqualToquerydecimal?No
DisplayOrderNotEqualToquerydecimal?No
DisplayOrderBetweenqueryNullable<Decimal>[]No
DisplayOrderInqueryNullable<Decimal>[]No
CellTypequeryshort?No
CellTypeGreaterThanOrEqualToqueryshort?No
CellTypeGreaterThanqueryshort?No
CellTypeLessThanqueryshort?No
CellTypeLessThanOrEqualToqueryshort?No
CellTypeNotEqualToqueryshort?No
CellTypeBetweenqueryNullable<Int16>[]No
CellTypeInqueryNullable<Int16>[]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
SY_Plugin_RecIDqueryGuid?No
SY_Plugin_RecIDInqueryGuid[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BR_CustomSetting Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
LastSavedDateTimeformDateTimeNo
SettingDescriptionformstringNo
SettingNameformstringNo
DisplayOrderformdecimal?No
CellTypeformshort?No
ScriptFormatCellformstringNo
ScriptButtonClickedformstringNo
ScriptReadDataformstringNo
SY_Plugin_RecIDformGuidNo
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 .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 /csv/reply/BR_CustomSettingQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SettingID":"String","SettingIDStartsWith":"String","SettingIDEndsWith":"String","SettingIDContains":"String","SettingIDLike":"String","SettingIDBetween":["String"],"SettingIDIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"SettingDescription":"String","SettingDescriptionStartsWith":"String","SettingDescriptionEndsWith":"String","SettingDescriptionContains":"String","SettingDescriptionLike":"String","SettingDescriptionBetween":["String"],"SettingDescriptionIn":["String"],"SettingName":"String","SettingNameStartsWith":"String","SettingNameEndsWith":"String","SettingNameContains":"String","SettingNameLike":"String","SettingNameBetween":["String"],"SettingNameIn":["String"],"DisplayOrder":0,"DisplayOrderGreaterThanOrEqualTo":0,"DisplayOrderGreaterThan":0,"DisplayOrderLessThan":0,"DisplayOrderLessThanOrEqualTo":0,"DisplayOrderNotEqualTo":0,"DisplayOrderBetween":[0],"DisplayOrderIn":[0],"CellType":0,"CellTypeGreaterThanOrEqualTo":0,"CellTypeGreaterThan":0,"CellTypeLessThan":0,"CellTypeLessThanOrEqualTo":0,"CellTypeNotEqualTo":0,"CellTypeBetween":[0],"CellTypeIn":[0],"ScriptFormatCell":"String","ScriptFormatCellStartsWith":"String","ScriptFormatCellEndsWith":"String","ScriptFormatCellContains":"String","ScriptFormatCellLike":"String","ScriptFormatCellBetween":["String"],"ScriptFormatCellIn":["String"],"ScriptButtonClicked":"String","ScriptButtonClickedStartsWith":"String","ScriptButtonClickedEndsWith":"String","ScriptButtonClickedContains":"String","ScriptButtonClickedLike":"String","ScriptButtonClickedBetween":["String"],"ScriptButtonClickedIn":["String"],"ScriptReadData":"String","ScriptReadDataStartsWith":"String","ScriptReadDataEndsWith":"String","ScriptReadDataContains":"String","ScriptReadDataLike":"String","ScriptReadDataBetween":["String"],"ScriptReadDataIn":["String"],"SY_Plugin_RecID":"00000000000000000000000000000000","SY_Plugin_RecIDIn":["00000000-0000-0000-0000-000000000000"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"SettingID":"String","SettingDescription":"String","SettingName":"String","DisplayOrder":0,"CellType":0,"ScriptFormatCell":"String","ScriptButtonClicked":"String","ScriptReadData":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}