| 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 | |
| YearNo | query | int? | No | |
| YearNoGreaterThanOrEqualTo | query | int? | No | |
| YearNoGreaterThan | query | int? | No | |
| YearNoLessThan | query | int? | No | |
| YearNoLessThanOrEqualTo | query | int? | No | |
| YearNoNotEqualTo | query | int? | No | |
| YearNoBetween | query | Nullable<Int32>[] | No | |
| YearNoIn | query | Nullable<Int32>[] | No | |
| MonthNo | query | int? | No | |
| MonthNoGreaterThanOrEqualTo | query | int? | No | |
| MonthNoGreaterThan | query | int? | No | |
| MonthNoLessThan | query | int? | No | |
| MonthNoLessThanOrEqualTo | query | int? | No | |
| MonthNoNotEqualTo | query | int? | No | |
| MonthNoBetween | query | Nullable<Int32>[] | No | |
| MonthNoIn | query | Nullable<Int32>[] | No | |
| TotalQty | query | decimal? | No | |
| TotalQtyGreaterThanOrEqualTo | query | decimal? | No | |
| TotalQtyGreaterThan | query | decimal? | No | |
| TotalQtyLessThan | query | decimal? | No | |
| TotalQtyLessThanOrEqualTo | query | decimal? | No | |
| TotalQtyNotEqualTo | query | decimal? | No | |
| TotalQtyBetween | query | Nullable<Decimal>[] | No | |
| TotalQtyIn | query | Nullable<Decimal>[] | 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 | |
| YearNo | form | int? | No | |
| MonthNo | form | int? | No | |
| TotalQty | form | decimal? | 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_SalesQtyQuery 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"],"YearNo":0,"YearNoGreaterThanOrEqualTo":0,"YearNoGreaterThan":0,"YearNoLessThan":0,"YearNoLessThanOrEqualTo":0,"YearNoNotEqualTo":0,"YearNoBetween":[0],"YearNoIn":[0],"MonthNo":0,"MonthNoGreaterThanOrEqualTo":0,"MonthNoGreaterThan":0,"MonthNoLessThan":0,"MonthNoLessThanOrEqualTo":0,"MonthNoNotEqualTo":0,"MonthNoBetween":[0],"MonthNoIn":[0],"TotalQty":0,"TotalQtyGreaterThanOrEqualTo":0,"TotalQtyGreaterThan":0,"TotalQtyLessThan":0,"TotalQtyLessThanOrEqualTo":0,"TotalQtyNotEqualTo":0,"TotalQtyBetween":[0],"TotalQtyIn":[0],"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","YearNo":0,"MonthNo":0,"TotalQty":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}