| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Charge | query | decimal? | No | |
| ChargeGreaterThanOrEqualTo | query | decimal? | No | |
| ChargeGreaterThan | query | decimal? | No | |
| ChargeLessThan | query | decimal? | No | |
| ChargeLessThanOrEqualTo | query | decimal? | No | |
| ChargeNotEqualTo | query | decimal? | No | |
| ChargeBetween | query | Nullable<Decimal>[] | No | |
| ChargeIn | query | Nullable<Decimal>[] | No | |
| Cost | query | decimal? | No | |
| CostGreaterThanOrEqualTo | query | decimal? | No | |
| CostGreaterThan | query | decimal? | No | |
| CostLessThan | query | decimal? | No | |
| CostLessThanOrEqualTo | query | decimal? | No | |
| CostNotEqualTo | query | decimal? | No | |
| CostBetween | query | Nullable<Decimal>[] | No | |
| CostIn | query | Nullable<Decimal>[] | No | |
| Qty | query | decimal? | No | |
| QtyGreaterThanOrEqualTo | query | decimal? | No | |
| QtyGreaterThan | query | decimal? | No | |
| QtyLessThan | query | decimal? | No | |
| QtyLessThanOrEqualTo | query | decimal? | No | |
| QtyNotEqualTo | query | decimal? | No | |
| QtyBetween | query | Nullable<Decimal>[] | No | |
| QtyIn | query | Nullable<Decimal>[] | No | |
| JobID | query | string | No | |
| JobIDStartsWith | query | string | No | |
| JobIDEndsWith | query | string | No | |
| JobIDContains | query | string | No | |
| JobIDLike | query | string | No | |
| JobIDBetween | query | string[] | No | |
| JobIDIn | query | string[] | No | |
| DefaultEstimate | query | byte? | No | |
| DefaultEstimateGreaterThanOrEqualTo | query | byte? | No | |
| DefaultEstimateGreaterThan | query | byte? | No | |
| DefaultEstimateLessThan | query | byte? | No | |
| DefaultEstimateLessThanOrEqualTo | query | byte? | No | |
| DefaultEstimateNotEqualTo | query | byte? | No | |
| DefaultEstimateBetween | query | Nullable<Byte>[] | No | |
| DefaultEstimateIn | query | Nullable<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 |
|---|---|---|---|---|
| Charge | form | decimal? | No | |
| Cost | form | decimal? | No | |
| Qty | form | decimal? | No | |
| JobID | form | string | No | |
| DefaultEstimate | 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/v_JB_MaterialsEstimateTotalsToDateQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Charge":0,"ChargeGreaterThanOrEqualTo":0,"ChargeGreaterThan":0,"ChargeLessThan":0,"ChargeLessThanOrEqualTo":0,"ChargeNotEqualTo":0,"ChargeBetween":[0],"ChargeIn":[0],"Cost":0,"CostGreaterThanOrEqualTo":0,"CostGreaterThan":0,"CostLessThan":0,"CostLessThanOrEqualTo":0,"CostNotEqualTo":0,"CostBetween":[0],"CostIn":[0],"Qty":0,"QtyGreaterThanOrEqualTo":0,"QtyGreaterThan":0,"QtyLessThan":0,"QtyLessThanOrEqualTo":0,"QtyNotEqualTo":0,"QtyBetween":[0],"QtyIn":[0],"JobID":"String","JobIDStartsWith":"String","JobIDEndsWith":"String","JobIDContains":"String","JobIDLike":"String","JobIDBetween":["String"],"JobIDIn":["String"],"DefaultEstimate":0,"DefaultEstimateGreaterThanOrEqualTo":0,"DefaultEstimateGreaterThan":0,"DefaultEstimateLessThan":0,"DefaultEstimateLessThanOrEqualTo":0,"DefaultEstimateNotEqualTo":0,"DefaultEstimateBetween":[0],"DefaultEstimateIn":[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":[{"Charge":0,"Cost":0,"Qty":0,"JobID":"String","DefaultEstimate":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}