| 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 | |
| Name | query | string | No | |
| NameStartsWith | query | string | No | |
| NameEndsWith | query | string | No | |
| NameContains | query | string | No | |
| NameLike | query | string | No | |
| NameBetween | query | string[] | No | |
| NameIn | query | string[] | No | |
| BillingType | query | byte? | No | |
| BillingTypeGreaterThanOrEqualTo | query | byte? | No | |
| BillingTypeGreaterThan | query | byte? | No | |
| BillingTypeLessThan | query | byte? | No | |
| BillingTypeLessThanOrEqualTo | query | byte? | No | |
| BillingTypeNotEqualTo | query | byte? | No | |
| BillingTypeBetween | query | byte[] | No | |
| BillingTypeIn | query | byte[] | No | |
| TradingCategory | query | int? | No | |
| TradingCategoryGreaterThanOrEqualTo | query | int? | No | |
| TradingCategoryGreaterThan | query | int? | No | |
| TradingCategoryLessThan | query | int? | No | |
| TradingCategoryLessThanOrEqualTo | query | int? | No | |
| TradingCategoryNotEqualTo | query | int? | No | |
| TradingCategoryBetween | query | int[] | No | |
| TradingCategoryIn | query | int[] | No | |
| DocumentType | query | byte? | No | |
| DocumentTypeGreaterThanOrEqualTo | query | byte? | No | |
| DocumentTypeGreaterThan | query | byte? | No | |
| DocumentTypeLessThan | query | byte? | No | |
| DocumentTypeLessThanOrEqualTo | query | byte? | No | |
| DocumentTypeNotEqualTo | query | byte? | No | |
| DocumentTypeBetween | query | byte[] | No | |
| DocumentTypeIn | query | byte[] | No | |
| NumberOfCopies | query | short? | No | |
| NumberOfCopiesGreaterThanOrEqualTo | query | short? | No | |
| NumberOfCopiesGreaterThan | query | short? | No | |
| NumberOfCopiesLessThan | query | short? | No | |
| NumberOfCopiesLessThanOrEqualTo | query | short? | No | |
| NumberOfCopiesNotEqualTo | query | short? | No | |
| NumberOfCopiesBetween | query | short[] | No | |
| NumberOfCopiesIn | query | short[] | No | |
| UseRange | query | bool? | No | |
| RangeType | query | byte? | No | |
| RangeTypeGreaterThanOrEqualTo | query | byte? | No | |
| RangeTypeGreaterThan | query | byte? | No | |
| RangeTypeLessThan | query | byte? | No | |
| RangeTypeLessThanOrEqualTo | query | byte? | No | |
| RangeTypeNotEqualTo | query | byte? | No | |
| RangeTypeBetween | query | byte[] | No | |
| RangeTypeIn | query | byte[] | No | |
| MinRange | query | decimal? | No | |
| MinRangeGreaterThanOrEqualTo | query | decimal? | No | |
| MinRangeGreaterThan | query | decimal? | No | |
| MinRangeLessThan | query | decimal? | No | |
| MinRangeLessThanOrEqualTo | query | decimal? | No | |
| MinRangeNotEqualTo | query | decimal? | No | |
| MinRangeBetween | query | decimal[] | No | |
| MinRangeIn | query | decimal[] | No | |
| MaxRange | query | decimal? | No | |
| MaxRangeGreaterThanOrEqualTo | query | decimal? | No | |
| MaxRangeGreaterThan | query | decimal? | No | |
| MaxRangeLessThan | query | decimal? | No | |
| MaxRangeLessThanOrEqualTo | query | decimal? | No | |
| MaxRangeNotEqualTo | query | decimal? | No | |
| MaxRangeBetween | query | decimal[] | No | |
| MaxRangeIn | query | decimal[] | No | |
| BackOrderStatus | query | byte? | No | |
| BackOrderStatusGreaterThanOrEqualTo | query | byte? | No | |
| BackOrderStatusGreaterThan | query | byte? | No | |
| BackOrderStatusLessThan | query | byte? | No | |
| BackOrderStatusLessThanOrEqualTo | query | byte? | No | |
| BackOrderStatusNotEqualTo | query | byte? | No | |
| BackOrderStatusBetween | query | byte[] | No | |
| BackOrderStatusIn | query | byte[] | 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 | |
| ItemNo | query | int? | No | |
| ItemNoGreaterThanOrEqualTo | query | int? | No | |
| ItemNoGreaterThan | query | int? | No | |
| ItemNoLessThan | query | int? | No | |
| ItemNoLessThanOrEqualTo | query | int? | No | |
| ItemNoNotEqualTo | query | int? | No | |
| ItemNoBetween | query | int[] | No | |
| ItemNoIn | query | int[] | No | |
| RowHash | query | byte[] | No | |
| SY_PrintGroup_RecID | query | string | No | |
| SY_PrintGroup_RecIDStartsWith | query | string | No | |
| SY_PrintGroup_RecIDEndsWith | query | string | No | |
| SY_PrintGroup_RecIDContains | query | string | No | |
| SY_PrintGroup_RecIDLike | query | string | No | |
| SY_PrintGroup_RecIDBetween | query | string[] | No | |
| SY_PrintGroup_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 | |
| Name | form | string | No | |
| BillingType | form | byte | No | |
| TradingCategory | form | int | No | |
| DocumentType | form | byte | No | |
| NumberOfCopies | form | short | No | |
| UseRange | form | bool | No | |
| RangeType | form | byte | No | |
| MinRange | form | decimal | No | |
| MaxRange | form | decimal | No | |
| BackOrderStatus | form | byte | No | |
| SY_Report_RecID | form | string | No | |
| SY_PrintGroupLogicalPrinter_RecID | form | string | No | |
| ItemNo | form | int | No | |
| RowHash | form | byte[] | No | |
| SY_PrintGroup_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/SO_ReportDefinitionQuery 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"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"BillingType":0,"BillingTypeGreaterThanOrEqualTo":0,"BillingTypeGreaterThan":0,"BillingTypeLessThan":0,"BillingTypeLessThanOrEqualTo":0,"BillingTypeNotEqualTo":0,"BillingTypeBetween":"AA==","BillingTypeIn":"AA==","TradingCategory":0,"TradingCategoryGreaterThanOrEqualTo":0,"TradingCategoryGreaterThan":0,"TradingCategoryLessThan":0,"TradingCategoryLessThanOrEqualTo":0,"TradingCategoryNotEqualTo":0,"TradingCategoryBetween":[0],"TradingCategoryIn":[0],"DocumentType":0,"DocumentTypeGreaterThanOrEqualTo":0,"DocumentTypeGreaterThan":0,"DocumentTypeLessThan":0,"DocumentTypeLessThanOrEqualTo":0,"DocumentTypeNotEqualTo":0,"DocumentTypeBetween":"AA==","DocumentTypeIn":"AA==","NumberOfCopies":0,"NumberOfCopiesGreaterThanOrEqualTo":0,"NumberOfCopiesGreaterThan":0,"NumberOfCopiesLessThan":0,"NumberOfCopiesLessThanOrEqualTo":0,"NumberOfCopiesNotEqualTo":0,"NumberOfCopiesBetween":[0],"NumberOfCopiesIn":[0],"UseRange":false,"RangeType":0,"RangeTypeGreaterThanOrEqualTo":0,"RangeTypeGreaterThan":0,"RangeTypeLessThan":0,"RangeTypeLessThanOrEqualTo":0,"RangeTypeNotEqualTo":0,"RangeTypeBetween":"AA==","RangeTypeIn":"AA==","MinRange":0,"MinRangeGreaterThanOrEqualTo":0,"MinRangeGreaterThan":0,"MinRangeLessThan":0,"MinRangeLessThanOrEqualTo":0,"MinRangeNotEqualTo":0,"MinRangeBetween":[0],"MinRangeIn":[0],"MaxRange":0,"MaxRangeGreaterThanOrEqualTo":0,"MaxRangeGreaterThan":0,"MaxRangeLessThan":0,"MaxRangeLessThanOrEqualTo":0,"MaxRangeNotEqualTo":0,"MaxRangeBetween":[0],"MaxRangeIn":[0],"BackOrderStatus":0,"BackOrderStatusGreaterThanOrEqualTo":0,"BackOrderStatusGreaterThan":0,"BackOrderStatusLessThan":0,"BackOrderStatusLessThanOrEqualTo":0,"BackOrderStatusNotEqualTo":0,"BackOrderStatusBetween":"AA==","BackOrderStatusIn":"AA==","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"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","SY_PrintGroup_RecID":"String","SY_PrintGroup_RecIDStartsWith":"String","SY_PrintGroup_RecIDEndsWith":"String","SY_PrintGroup_RecIDContains":"String","SY_PrintGroup_RecIDLike":"String","SY_PrintGroup_RecIDBetween":["String"],"SY_PrintGroup_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","Name":"String","SY_Report_RecID":"String","SY_PrintGroupLogicalPrinter_RecID":"String","RowHash":"AA==","SY_PrintGroup_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"}}}