| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| BatchID | query | string | No | |
| BatchIDStartsWith | query | string | No | |
| BatchIDEndsWith | query | string | No | |
| BatchIDContains | query | string | No | |
| BatchIDLike | query | string | No | |
| BatchIDBetween | query | string[] | No | |
| BatchIDIn | query | string[] | No | |
| DatabaseVersion | query | string | No | |
| DatabaseVersionStartsWith | query | string | No | |
| DatabaseVersionEndsWith | query | string | No | |
| DatabaseVersionContains | query | string | No | |
| DatabaseVersionLike | query | string | No | |
| DatabaseVersionBetween | query | string[] | No | |
| DatabaseVersionIn | query | string[] | No | |
| Section | query | string | No | |
| SectionStartsWith | query | string | No | |
| SectionEndsWith | query | string | No | |
| SectionContains | query | string | No | |
| SectionLike | query | string | No | |
| SectionBetween | query | string[] | No | |
| SectionIn | query | string[] | No | |
| SectionCaption | query | string | No | |
| SectionCaptionStartsWith | query | string | No | |
| SectionCaptionEndsWith | query | string | No | |
| SectionCaptionContains | query | string | No | |
| SectionCaptionLike | query | string | No | |
| SectionCaptionBetween | query | string[] | No | |
| SectionCaptionIn | query | string[] | No | |
| IDKey | query | string | No | |
| IDKeyStartsWith | query | string | No | |
| IDKeyEndsWith | query | string | No | |
| IDKeyContains | query | string | No | |
| IDKeyLike | query | string | No | |
| IDKeyBetween | query | string[] | No | |
| IDKeyIn | query | string[] | No | |
| Contents | query | string | No | |
| ContentsStartsWith | query | string | No | |
| ContentsEndsWith | query | string | No | |
| ContentsContains | query | string | No | |
| ContentsLike | query | string | No | |
| ContentsBetween | query | string[] | No | |
| ContentsIn | query | string[] | No | |
| NewContents | query | string | No | |
| NewContentsStartsWith | query | string | No | |
| NewContentsEndsWith | query | string | No | |
| NewContentsContains | query | string | No | |
| NewContentsLike | query | string | No | |
| NewContentsBetween | query | string[] | No | |
| NewContentsIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | 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 | short[] | No | |
| CellTypeIn | query | short[] | No | |
| LastModifiedByStaffID | query | string | No | |
| LastModifiedByStaffIDStartsWith | query | string | No | |
| LastModifiedByStaffIDEndsWith | query | string | No | |
| LastModifiedByStaffIDContains | query | string | No | |
| LastModifiedByStaffIDLike | query | string | No | |
| LastModifiedByStaffIDBetween | query | string[] | No | |
| LastModifiedByStaffIDIn | 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 |
| 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 |
|---|---|---|---|---|
| RecID | form | string | No | |
| BatchID | form | string | No | |
| DatabaseVersion | form | string | No | |
| Section | form | string | No | |
| SectionCaption | form | string | No | |
| IDKey | form | string | No | |
| Contents | form | string | No | |
| NewContents | form | string | No | |
| Description | form | string | No | |
| CellType | form | short | No | |
| LastModifiedByStaffID | form | string | No | |
| LastSavedDateTime | form | DateTime | 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/SY_SysValuesLogQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"BatchID":"String","BatchIDStartsWith":"String","BatchIDEndsWith":"String","BatchIDContains":"String","BatchIDLike":"String","BatchIDBetween":["String"],"BatchIDIn":["String"],"DatabaseVersion":"String","DatabaseVersionStartsWith":"String","DatabaseVersionEndsWith":"String","DatabaseVersionContains":"String","DatabaseVersionLike":"String","DatabaseVersionBetween":["String"],"DatabaseVersionIn":["String"],"Section":"String","SectionStartsWith":"String","SectionEndsWith":"String","SectionContains":"String","SectionLike":"String","SectionBetween":["String"],"SectionIn":["String"],"SectionCaption":"String","SectionCaptionStartsWith":"String","SectionCaptionEndsWith":"String","SectionCaptionContains":"String","SectionCaptionLike":"String","SectionCaptionBetween":["String"],"SectionCaptionIn":["String"],"IDKey":"String","IDKeyStartsWith":"String","IDKeyEndsWith":"String","IDKeyContains":"String","IDKeyLike":"String","IDKeyBetween":["String"],"IDKeyIn":["String"],"Contents":"String","ContentsStartsWith":"String","ContentsEndsWith":"String","ContentsContains":"String","ContentsLike":"String","ContentsBetween":["String"],"ContentsIn":["String"],"NewContents":"String","NewContentsStartsWith":"String","NewContentsEndsWith":"String","NewContentsContains":"String","NewContentsLike":"String","NewContentsBetween":["String"],"NewContentsIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"CellType":0,"CellTypeGreaterThanOrEqualTo":0,"CellTypeGreaterThan":0,"CellTypeLessThan":0,"CellTypeLessThanOrEqualTo":0,"CellTypeNotEqualTo":0,"CellTypeBetween":[0],"CellTypeIn":[0],"LastModifiedByStaffID":"String","LastModifiedByStaffIDStartsWith":"String","LastModifiedByStaffIDEndsWith":"String","LastModifiedByStaffIDContains":"String","LastModifiedByStaffIDLike":"String","LastModifiedByStaffIDBetween":["String"],"LastModifiedByStaffIDIn":["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"],"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":[{"RecID":"String","BatchID":"String","DatabaseVersion":"String","Section":"String","SectionCaption":"String","IDKey":"String","Contents":"String","NewContents":"String","Description":"String","LastModifiedByStaffID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}