| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SettingID | query | string | No | |
| SettingIDStartsWith | query | string | No | |
| SettingIDEndsWith | query | string | No | |
| SettingIDContains | query | string | No | |
| SettingIDLike | query | string | No | |
| SettingIDBetween | query | string[] | No | |
| SettingIDIn | query | string[] | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | DateTime[] | No | |
| LastSavedDateTimeIn | query | DateTime[] | No | |
| SettingDescription | query | string | No | |
| SettingDescriptionStartsWith | query | string | No | |
| SettingDescriptionEndsWith | query | string | No | |
| SettingDescriptionContains | query | string | No | |
| SettingDescriptionLike | query | string | No | |
| SettingDescriptionBetween | query | string[] | No | |
| SettingDescriptionIn | query | string[] | No | |
| SettingName | query | string | No | |
| SettingNameStartsWith | query | string | No | |
| SettingNameEndsWith | query | string | No | |
| SettingNameContains | query | string | No | |
| SettingNameLike | query | string | No | |
| SettingNameBetween | query | string[] | No | |
| SettingNameIn | query | string[] | No | |
| DisplayOrder | query | decimal? | No | |
| DisplayOrderGreaterThanOrEqualTo | query | decimal? | No | |
| DisplayOrderGreaterThan | query | decimal? | No | |
| DisplayOrderLessThan | query | decimal? | No | |
| DisplayOrderLessThanOrEqualTo | query | decimal? | No | |
| DisplayOrderNotEqualTo | query | decimal? | No | |
| DisplayOrderBetween | query | Nullable<Decimal>[] | No | |
| DisplayOrderIn | query | Nullable<Decimal>[] | No | |
| CellType | query | short? | No | |
| CellTypeGreaterThanOrEqualTo | query | short? | No | |
| CellTypeGreaterThan | query | short? | No | |
| CellTypeLessThan | query | short? | No | |
| CellTypeLessThanOrEqualTo | query | short? | No | |
| CellTypeNotEqualTo | query | short? | No | |
| CellTypeBetween | query | Nullable<Int16>[] | No | |
| CellTypeIn | query | Nullable<Int16>[] | No | |
| ScriptFormatCell | query | string | No | |
| ScriptFormatCellStartsWith | query | string | No | |
| ScriptFormatCellEndsWith | query | string | No | |
| ScriptFormatCellContains | query | string | No | |
| ScriptFormatCellLike | query | string | No | |
| ScriptFormatCellBetween | query | string[] | No | |
| ScriptFormatCellIn | query | string[] | No | |
| ScriptButtonClicked | query | string | No | |
| ScriptButtonClickedStartsWith | query | string | No | |
| ScriptButtonClickedEndsWith | query | string | No | |
| ScriptButtonClickedContains | query | string | No | |
| ScriptButtonClickedLike | query | string | No | |
| ScriptButtonClickedBetween | query | string[] | No | |
| ScriptButtonClickedIn | query | string[] | No | |
| ScriptReadData | query | string | No | |
| ScriptReadDataStartsWith | query | string | No | |
| ScriptReadDataEndsWith | query | string | No | |
| ScriptReadDataContains | query | string | No | |
| ScriptReadDataLike | query | string | No | |
| ScriptReadDataBetween | query | string[] | No | |
| ScriptReadDataIn | query | string[] | No | |
| SY_Plugin_RecID | query | Guid? | No | |
| SY_Plugin_RecIDIn | query | Guid[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SettingID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| SettingDescription | form | string | No | |
| SettingName | form | string | No | |
| DisplayOrder | form | decimal? | No | |
| CellType | form | short? | No | |
| ScriptFormatCell | form | string | No | |
| ScriptButtonClicked | form | string | No | |
| ScriptReadData | form | string | No | |
| SY_Plugin_RecID | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}