| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SourceID | query | string | No | |
| SourceIDStartsWith | query | string | No | |
| SourceIDEndsWith | query | string | No | |
| SourceIDContains | query | string | No | |
| SourceIDLike | query | string | No | |
| SourceIDBetween | query | string[] | No | |
| SourceIDIn | query | string[] | No | |
| BOM_QuantitySold | query | decimal? | No | |
| BOM_QuantitySoldGreaterThanOrEqualTo | query | decimal? | No | |
| BOM_QuantitySoldGreaterThan | query | decimal? | No | |
| BOM_QuantitySoldLessThan | query | decimal? | No | |
| BOM_QuantitySoldLessThanOrEqualTo | query | decimal? | No | |
| BOM_QuantitySoldNotEqualTo | query | decimal? | No | |
| BOM_QuantitySoldBetween | query | Nullable<Decimal>[] | No | |
| BOM_QuantitySoldIn | 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 |
|---|---|---|---|---|
| SourceID | form | string | No | |
| BOM_QuantitySold | 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/V_BOMSoldQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"SourceID":"String","SourceIDStartsWith":"String","SourceIDEndsWith":"String","SourceIDContains":"String","SourceIDLike":"String","SourceIDBetween":["String"],"SourceIDIn":["String"],"BOM_QuantitySold":0,"BOM_QuantitySoldGreaterThanOrEqualTo":0,"BOM_QuantitySoldGreaterThan":0,"BOM_QuantitySoldLessThan":0,"BOM_QuantitySoldLessThanOrEqualTo":0,"BOM_QuantitySoldNotEqualTo":0,"BOM_QuantitySoldBetween":[0],"BOM_QuantitySoldIn":[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":[{"SourceID":"String","BOM_QuantitySold":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}