| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StockTakeID | query | string | No | |
| StockTakeIDStartsWith | query | string | No | |
| StockTakeIDEndsWith | query | string | No | |
| StockTakeIDContains | query | string | No | |
| StockTakeIDLike | query | string | No | |
| StockTakeIDBetween | query | string[] | No | |
| StockTakeIDIn | 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 | |
| StockTakeNumber | query | string | No | |
| StockTakeNumberStartsWith | query | string | No | |
| StockTakeNumberEndsWith | query | string | No | |
| StockTakeNumberContains | query | string | No | |
| StockTakeNumberLike | query | string | No | |
| StockTakeNumberBetween | query | string[] | No | |
| StockTakeNumberIn | query | string[] | No | |
| DateCreated | query | DateTime? | No | |
| DateCreatedGreaterThanOrEqualTo | query | DateTime? | No | |
| DateCreatedGreaterThan | query | DateTime? | No | |
| DateCreatedLessThan | query | DateTime? | No | |
| DateCreatedLessThanOrEqualTo | query | DateTime? | No | |
| DateCreatedNotEqualTo | query | DateTime? | No | |
| DateCreatedBetween | query | DateTime[] | No | |
| DateCreatedIn | query | DateTime[] | No | |
| UserID | query | string | No | |
| UserIDStartsWith | query | string | No | |
| UserIDEndsWith | query | string | No | |
| UserIDContains | query | string | No | |
| UserIDLike | query | string | No | |
| UserIDBetween | query | string[] | No | |
| UserIDIn | query | string[] | No | |
| WarehouseID | query | string | No | |
| WarehouseIDStartsWith | query | string | No | |
| WarehouseIDEndsWith | query | string | No | |
| WarehouseIDContains | query | string | No | |
| WarehouseIDLike | query | string | No | |
| WarehouseIDBetween | query | string[] | No | |
| WarehouseIDIn | query | string[] | No | |
| Status | query | short? | No | |
| StatusGreaterThanOrEqualTo | query | short? | No | |
| StatusGreaterThan | query | short? | No | |
| StatusLessThan | query | short? | No | |
| StatusLessThanOrEqualTo | query | short? | No | |
| StatusNotEqualTo | query | short? | No | |
| StatusBetween | query | short[] | No | |
| StatusIn | query | short[] | No | |
| Mode | query | bool? | 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 |
|---|---|---|---|---|
| StockTakeID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| StockTakeNumber | form | string | No | |
| DateCreated | form | DateTime | No | |
| UserID | form | string | No | |
| WarehouseID | form | string | No | |
| Status | form | short | No | |
| Mode | form | bool | 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/IN_StockTakeMainQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"StockTakeID":"String","StockTakeIDStartsWith":"String","StockTakeIDEndsWith":"String","StockTakeIDContains":"String","StockTakeIDLike":"String","StockTakeIDBetween":["String"],"StockTakeIDIn":["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"],"StockTakeNumber":"String","StockTakeNumberStartsWith":"String","StockTakeNumberEndsWith":"String","StockTakeNumberContains":"String","StockTakeNumberLike":"String","StockTakeNumberBetween":["String"],"StockTakeNumberIn":["String"],"DateCreated":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedNotEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedBetween":["0001-01-01T00:00:00.0000000"],"DateCreatedIn":["0001-01-01T00:00:00.0000000"],"UserID":"String","UserIDStartsWith":"String","UserIDEndsWith":"String","UserIDContains":"String","UserIDLike":"String","UserIDBetween":["String"],"UserIDIn":["String"],"WarehouseID":"String","WarehouseIDStartsWith":"String","WarehouseIDEndsWith":"String","WarehouseIDContains":"String","WarehouseIDLike":"String","WarehouseIDBetween":["String"],"WarehouseIDIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"Mode":false,"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":[{"StockTakeID":"String","StockTakeNumber":"String","UserID":"String","WarehouseID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}