| 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 | |
| SH_Main_RecID | query | string | No | |
| SH_Main_RecIDStartsWith | query | string | No | |
| SH_Main_RecIDEndsWith | query | string | No | |
| SH_Main_RecIDContains | query | string | No | |
| SH_Main_RecIDLike | query | string | No | |
| SH_Main_RecIDBetween | query | string[] | No | |
| SH_Main_RecIDIn | query | string[] | No | |
| PO_Main_RecID | query | string | No | |
| PO_Main_RecIDStartsWith | query | string | No | |
| PO_Main_RecIDEndsWith | query | string | No | |
| PO_Main_RecIDContains | query | string | No | |
| PO_Main_RecIDLike | query | string | No | |
| PO_Main_RecIDBetween | query | string[] | No | |
| PO_Main_RecIDIn | query | string[] | No | |
| DisplayLines | query | bool? | No | |
| FXRate | query | decimal? | No | |
| FXRateGreaterThanOrEqualTo | query | decimal? | No | |
| FXRateGreaterThan | query | decimal? | No | |
| FXRateLessThan | query | decimal? | No | |
| FXRateLessThanOrEqualTo | query | decimal? | No | |
| FXRateNotEqualTo | query | decimal? | No | |
| FXRateBetween | query | Nullable<Decimal>[] | No | |
| FXRateIn | query | Nullable<Decimal>[] | No | |
| UserField1 | query | string | No | |
| UserField1StartsWith | query | string | No | |
| UserField1EndsWith | query | string | No | |
| UserField1Contains | query | string | No | |
| UserField1Like | query | string | No | |
| UserField1Between | query | string[] | No | |
| UserField1In | query | string[] | No | |
| UserField2 | query | string | No | |
| UserField2StartsWith | query | string | No | |
| UserField2EndsWith | query | string | No | |
| UserField2Contains | query | string | No | |
| UserField2Like | query | string | No | |
| UserField2Between | query | string[] | No | |
| UserField2In | query | string[] | No | |
| UserField3 | query | string | No | |
| UserField3StartsWith | query | string | No | |
| UserField3EndsWith | query | string | No | |
| UserField3Contains | query | string | No | |
| UserField3Like | query | string | No | |
| UserField3Between | query | string[] | No | |
| UserField3In | query | string[] | No | |
| UserField4 | query | string | No | |
| UserField4StartsWith | query | string | No | |
| UserField4EndsWith | query | string | No | |
| UserField4Contains | query | string | No | |
| UserField4Like | query | string | No | |
| UserField4Between | query | string[] | No | |
| UserField4In | query | string[] | No | |
| UserField5 | query | string | No | |
| UserField5StartsWith | query | string | No | |
| UserField5EndsWith | query | string | No | |
| UserField5Contains | query | string | No | |
| UserField5Like | query | string | No | |
| UserField5Between | query | string[] | No | |
| UserField5In | query | string[] | No | |
| UserField6 | query | string | No | |
| UserField6StartsWith | query | string | No | |
| UserField6EndsWith | query | string | No | |
| UserField6Contains | query | string | No | |
| UserField6Like | query | string | No | |
| UserField6Between | query | string[] | No | |
| UserField6In | query | string[] | No | |
| UserField7 | query | string | No | |
| UserField7StartsWith | query | string | No | |
| UserField7EndsWith | query | string | No | |
| UserField7Contains | query | string | No | |
| UserField7Like | query | string | No | |
| UserField7Between | query | string[] | No | |
| UserField7In | query | string[] | No | |
| UserField8 | query | string | No | |
| UserField8StartsWith | query | string | No | |
| UserField8EndsWith | query | string | No | |
| UserField8Contains | query | string | No | |
| UserField8Like | query | string | No | |
| UserField8Between | query | string[] | No | |
| UserField8In | query | string[] | No | |
| UserField9 | query | string | No | |
| UserField9StartsWith | query | string | No | |
| UserField9EndsWith | query | string | No | |
| UserField9Contains | query | string | No | |
| UserField9Like | query | string | No | |
| UserField9Between | query | string[] | No | |
| UserField9In | query | string[] | No | |
| UserField10 | query | string | No | |
| UserField10StartsWith | query | string | No | |
| UserField10EndsWith | query | string | No | |
| UserField10Contains | query | string | No | |
| UserField10Like | query | string | No | |
| UserField10Between | query | string[] | No | |
| UserField10In | 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 |
| 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 | |
| SH_Main_RecID | form | string | No | |
| PO_Main_RecID | form | string | No | |
| DisplayLines | form | bool | No | |
| FXRate | form | decimal? | No | |
| UserField1 | form | string | No | |
| UserField2 | form | string | No | |
| UserField3 | form | string | No | |
| UserField4 | form | string | No | |
| UserField5 | form | string | No | |
| UserField6 | form | string | No | |
| UserField7 | form | string | No | |
| UserField8 | form | string | No | |
| UserField9 | form | string | No | |
| UserField10 | form | string | No | |
| ItemNo | form | int | No | |
| RowHash | form | byte[] | 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/SH_PurchaseOrdersQuery 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"],"SH_Main_RecID":"String","SH_Main_RecIDStartsWith":"String","SH_Main_RecIDEndsWith":"String","SH_Main_RecIDContains":"String","SH_Main_RecIDLike":"String","SH_Main_RecIDBetween":["String"],"SH_Main_RecIDIn":["String"],"PO_Main_RecID":"String","PO_Main_RecIDStartsWith":"String","PO_Main_RecIDEndsWith":"String","PO_Main_RecIDContains":"String","PO_Main_RecIDLike":"String","PO_Main_RecIDBetween":["String"],"PO_Main_RecIDIn":["String"],"DisplayLines":false,"FXRate":0,"FXRateGreaterThanOrEqualTo":0,"FXRateGreaterThan":0,"FXRateLessThan":0,"FXRateLessThanOrEqualTo":0,"FXRateNotEqualTo":0,"FXRateBetween":[0],"FXRateIn":[0],"UserField1":"String","UserField1StartsWith":"String","UserField1EndsWith":"String","UserField1Contains":"String","UserField1Like":"String","UserField1Between":["String"],"UserField1In":["String"],"UserField2":"String","UserField2StartsWith":"String","UserField2EndsWith":"String","UserField2Contains":"String","UserField2Like":"String","UserField2Between":["String"],"UserField2In":["String"],"UserField3":"String","UserField3StartsWith":"String","UserField3EndsWith":"String","UserField3Contains":"String","UserField3Like":"String","UserField3Between":["String"],"UserField3In":["String"],"UserField4":"String","UserField4StartsWith":"String","UserField4EndsWith":"String","UserField4Contains":"String","UserField4Like":"String","UserField4Between":["String"],"UserField4In":["String"],"UserField5":"String","UserField5StartsWith":"String","UserField5EndsWith":"String","UserField5Contains":"String","UserField5Like":"String","UserField5Between":["String"],"UserField5In":["String"],"UserField6":"String","UserField6StartsWith":"String","UserField6EndsWith":"String","UserField6Contains":"String","UserField6Like":"String","UserField6Between":["String"],"UserField6In":["String"],"UserField7":"String","UserField7StartsWith":"String","UserField7EndsWith":"String","UserField7Contains":"String","UserField7Like":"String","UserField7Between":["String"],"UserField7In":["String"],"UserField8":"String","UserField8StartsWith":"String","UserField8EndsWith":"String","UserField8Contains":"String","UserField8Like":"String","UserField8Between":["String"],"UserField8In":["String"],"UserField9":"String","UserField9StartsWith":"String","UserField9EndsWith":"String","UserField9Contains":"String","UserField9Like":"String","UserField9Between":["String"],"UserField9In":["String"],"UserField10":"String","UserField10StartsWith":"String","UserField10EndsWith":"String","UserField10Contains":"String","UserField10Like":"String","UserField10Between":["String"],"UserField10In":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","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","SH_Main_RecID":"String","PO_Main_RecID":"String","FXRate":0,"UserField1":"String","UserField2":"String","UserField3":"String","UserField4":"String","UserField5":"String","UserField6":"String","UserField7":"String","UserField8":"String","UserField9":"String","UserField10":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}