Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InventoryID | query | string | No | |
InventoryIDStartsWith | query | string | No | |
InventoryIDEndsWith | query | string | No | |
InventoryIDContains | query | string | No | |
InventoryIDLike | query | string | No | |
InventoryIDBetween | query | string[] | No | |
InventoryIDIn | query | string[] | No | |
SOH | query | decimal? | No | |
SOHGreaterThanOrEqualTo | query | decimal? | No | |
SOHGreaterThan | query | decimal? | No | |
SOHLessThan | query | decimal? | No | |
SOHLessThanOrEqualTo | query | decimal? | No | |
SOHNotEqualTo | query | decimal? | No | |
SOHBetween | query | Nullable<Decimal>[] | No | |
SOHIn | query | Nullable<Decimal>[] | No | |
Tax | query | decimal? | No | |
TaxGreaterThanOrEqualTo | query | decimal? | No | |
TaxGreaterThan | query | decimal? | No | |
TaxLessThan | query | decimal? | No | |
TaxLessThanOrEqualTo | query | decimal? | No | |
TaxNotEqualTo | query | decimal? | No | |
TaxBetween | query | Nullable<Decimal>[] | No | |
TaxIn | query | Nullable<Decimal>[] | No | |
VOH | query | decimal? | No | |
VOHGreaterThanOrEqualTo | query | decimal? | No | |
VOHGreaterThan | query | decimal? | No | |
VOHLessThan | query | decimal? | No | |
VOHLessThanOrEqualTo | query | decimal? | No | |
VOHNotEqualTo | query | decimal? | No | |
VOHBetween | query | Nullable<Decimal>[] | No | |
VOHIn | query | Nullable<Decimal>[] | No | |
IN_LogicalID | query | string | No | |
IN_LogicalIDStartsWith | query | string | No | |
IN_LogicalIDEndsWith | query | string | No | |
IN_LogicalIDContains | query | string | No | |
IN_LogicalIDLike | query | string | No | |
IN_LogicalIDBetween | query | string[] | No | |
IN_LogicalIDIn | 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 |
---|---|---|---|---|
InventoryID | form | string | No | |
SOH | form | decimal? | No | |
Tax | form | decimal? | No | |
VOH | form | decimal? | No | |
IN_LogicalID | 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/INV_SOH1Query HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"SOH":0,"SOHGreaterThanOrEqualTo":0,"SOHGreaterThan":0,"SOHLessThan":0,"SOHLessThanOrEqualTo":0,"SOHNotEqualTo":0,"SOHBetween":[0],"SOHIn":[0],"Tax":0,"TaxGreaterThanOrEqualTo":0,"TaxGreaterThan":0,"TaxLessThan":0,"TaxLessThanOrEqualTo":0,"TaxNotEqualTo":0,"TaxBetween":[0],"TaxIn":[0],"VOH":0,"VOHGreaterThanOrEqualTo":0,"VOHGreaterThan":0,"VOHLessThan":0,"VOHLessThanOrEqualTo":0,"VOHNotEqualTo":0,"VOHBetween":[0],"VOHIn":[0],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["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":[{"InventoryID":"String","SOH":0,"Tax":0,"VOH":0,"IN_LogicalID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}