| 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 | |
| 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 | |
| DisplayOrder | query | int? | No | |
| DisplayOrderGreaterThanOrEqualTo | query | int? | No | |
| DisplayOrderGreaterThan | query | int? | No | |
| DisplayOrderLessThan | query | int? | No | |
| DisplayOrderLessThanOrEqualTo | query | int? | No | |
| DisplayOrderNotEqualTo | query | int? | No | |
| DisplayOrderBetween | query | int[] | No | |
| DisplayOrderIn | query | int[] | No | |
| BillType | query | short? | No | |
| BillTypeGreaterThanOrEqualTo | query | short? | No | |
| BillTypeGreaterThan | query | short? | No | |
| BillTypeLessThan | query | short? | No | |
| BillTypeLessThanOrEqualTo | query | short? | No | |
| BillTypeNotEqualTo | query | short? | No | |
| BillTypeBetween | query | short[] | No | |
| BillTypeIn | query | short[] | No | |
| TradingCategory | query | short? | No | |
| TradingCategoryGreaterThanOrEqualTo | query | short? | No | |
| TradingCategoryGreaterThan | query | short? | No | |
| TradingCategoryLessThan | query | short? | No | |
| TradingCategoryLessThanOrEqualTo | query | short? | No | |
| TradingCategoryNotEqualTo | query | short? | No | |
| TradingCategoryBetween | query | short[] | No | |
| TradingCategoryIn | query | short[] | No | |
| BackOrderStatus | query | short? | No | |
| BackOrderStatusGreaterThanOrEqualTo | query | short? | No | |
| BackOrderStatusGreaterThan | query | short? | No | |
| BackOrderStatusLessThan | query | short? | No | |
| BackOrderStatusLessThanOrEqualTo | query | short? | No | |
| BackOrderStatusNotEqualTo | query | short? | No | |
| BackOrderStatusBetween | query | short[] | No | |
| BackOrderStatusIn | query | short[] | No | |
| ReportType | query | short? | No | |
| ReportTypeGreaterThanOrEqualTo | query | short? | No | |
| ReportTypeGreaterThan | query | short? | No | |
| ReportTypeLessThan | query | short? | No | |
| ReportTypeLessThanOrEqualTo | query | short? | No | |
| ReportTypeNotEqualTo | query | short? | No | |
| ReportTypeBetween | query | short[] | No | |
| ReportTypeIn | query | short[] | No | |
| ReportDescription | query | string | No | |
| ReportDescriptionStartsWith | query | string | No | |
| ReportDescriptionEndsWith | query | string | No | |
| ReportDescriptionContains | query | string | No | |
| ReportDescriptionLike | query | string | No | |
| ReportDescriptionBetween | query | string[] | No | |
| ReportDescriptionIn | query | string[] | No | |
| NumberOfCopies | query | int? | No | |
| NumberOfCopiesGreaterThanOrEqualTo | query | int? | No | |
| NumberOfCopiesGreaterThan | query | int? | No | |
| NumberOfCopiesLessThan | query | int? | No | |
| NumberOfCopiesLessThanOrEqualTo | query | int? | No | |
| NumberOfCopiesNotEqualTo | query | int? | No | |
| NumberOfCopiesBetween | query | Nullable<Int32>[] | No | |
| NumberOfCopiesIn | query | Nullable<Int32>[] | No | |
| PrintFlag | query | bool? | No | |
| SY_Report_RecID | query | string | No | |
| SY_Report_RecIDStartsWith | query | string | No | |
| SY_Report_RecIDEndsWith | query | string | No | |
| SY_Report_RecIDContains | query | string | No | |
| SY_Report_RecIDLike | query | string | No | |
| SY_Report_RecIDBetween | query | string[] | No | |
| SY_Report_RecIDIn | query | string[] | No | |
| SY_PrintGroupLogicalPrinter_RecID | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDStartsWith | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDEndsWith | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDContains | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDLike | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDBetween | query | string[] | No | |
| SY_PrintGroupLogicalPrinter_RecIDIn | query | string[] | 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 | |
| LastSavedDateTime | form | DateTime | No | |
| DisplayOrder | form | int | No | |
| BillType | form | short | No | |
| TradingCategory | form | short | No | |
| BackOrderStatus | form | short | No | |
| ReportType | form | short | No | |
| ReportDescription | form | string | No | |
| NumberOfCopies | form | int? | No | |
| PrintFlag | form | bool? | No | |
| SY_Report_RecID | form | string | No | |
| SY_PrintGroupLogicalPrinter_RecID | form | string | 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/BO_ManualReleaseBatchReportsQuery 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"],"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"],"DisplayOrder":0,"DisplayOrderGreaterThanOrEqualTo":0,"DisplayOrderGreaterThan":0,"DisplayOrderLessThan":0,"DisplayOrderLessThanOrEqualTo":0,"DisplayOrderNotEqualTo":0,"DisplayOrderBetween":[0],"DisplayOrderIn":[0],"BillType":0,"BillTypeGreaterThanOrEqualTo":0,"BillTypeGreaterThan":0,"BillTypeLessThan":0,"BillTypeLessThanOrEqualTo":0,"BillTypeNotEqualTo":0,"BillTypeBetween":[0],"BillTypeIn":[0],"TradingCategory":0,"TradingCategoryGreaterThanOrEqualTo":0,"TradingCategoryGreaterThan":0,"TradingCategoryLessThan":0,"TradingCategoryLessThanOrEqualTo":0,"TradingCategoryNotEqualTo":0,"TradingCategoryBetween":[0],"TradingCategoryIn":[0],"BackOrderStatus":0,"BackOrderStatusGreaterThanOrEqualTo":0,"BackOrderStatusGreaterThan":0,"BackOrderStatusLessThan":0,"BackOrderStatusLessThanOrEqualTo":0,"BackOrderStatusNotEqualTo":0,"BackOrderStatusBetween":[0],"BackOrderStatusIn":[0],"ReportType":0,"ReportTypeGreaterThanOrEqualTo":0,"ReportTypeGreaterThan":0,"ReportTypeLessThan":0,"ReportTypeLessThanOrEqualTo":0,"ReportTypeNotEqualTo":0,"ReportTypeBetween":[0],"ReportTypeIn":[0],"ReportDescription":"String","ReportDescriptionStartsWith":"String","ReportDescriptionEndsWith":"String","ReportDescriptionContains":"String","ReportDescriptionLike":"String","ReportDescriptionBetween":["String"],"ReportDescriptionIn":["String"],"NumberOfCopies":0,"NumberOfCopiesGreaterThanOrEqualTo":0,"NumberOfCopiesGreaterThan":0,"NumberOfCopiesLessThan":0,"NumberOfCopiesLessThanOrEqualTo":0,"NumberOfCopiesNotEqualTo":0,"NumberOfCopiesBetween":[0],"NumberOfCopiesIn":[0],"PrintFlag":false,"SY_Report_RecID":"String","SY_Report_RecIDStartsWith":"String","SY_Report_RecIDEndsWith":"String","SY_Report_RecIDContains":"String","SY_Report_RecIDLike":"String","SY_Report_RecIDBetween":["String"],"SY_Report_RecIDIn":["String"],"SY_PrintGroupLogicalPrinter_RecID":"String","SY_PrintGroupLogicalPrinter_RecIDStartsWith":"String","SY_PrintGroupLogicalPrinter_RecIDEndsWith":"String","SY_PrintGroupLogicalPrinter_RecIDContains":"String","SY_PrintGroupLogicalPrinter_RecIDLike":"String","SY_PrintGroupLogicalPrinter_RecIDBetween":["String"],"SY_PrintGroupLogicalPrinter_RecIDIn":["String"],"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","ReportDescription":"String","NumberOfCopies":0,"PrintFlag":false,"SY_Report_RecID":"String","SY_PrintGroupLogicalPrinter_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"}}}