| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EstimateCharge | query | decimal? | No | |
| EstimateChargeGreaterThanOrEqualTo | query | decimal? | No | |
| EstimateChargeGreaterThan | query | decimal? | No | |
| EstimateChargeLessThan | query | decimal? | No | |
| EstimateChargeLessThanOrEqualTo | query | decimal? | No | |
| EstimateChargeNotEqualTo | query | decimal? | No | |
| EstimateChargeBetween | query | Nullable<Decimal>[] | No | |
| EstimateChargeIn | query | Nullable<Decimal>[] | No | |
| EstimateCost | query | decimal? | No | |
| EstimateCostGreaterThanOrEqualTo | query | decimal? | No | |
| EstimateCostGreaterThan | query | decimal? | No | |
| EstimateCostLessThan | query | decimal? | No | |
| EstimateCostLessThanOrEqualTo | query | decimal? | No | |
| EstimateCostNotEqualTo | query | decimal? | No | |
| EstimateCostBetween | query | Nullable<Decimal>[] | No | |
| EstimateCostIn | 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 |
| 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 |
|---|---|---|---|---|
| EstimateCharge | form | decimal? | No | |
| EstimateCost | form | decimal? | No | |
| JobID | 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/v_JB_DefaultEstimateQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"EstimateCharge":0,"EstimateChargeGreaterThanOrEqualTo":0,"EstimateChargeGreaterThan":0,"EstimateChargeLessThan":0,"EstimateChargeLessThanOrEqualTo":0,"EstimateChargeNotEqualTo":0,"EstimateChargeBetween":[0],"EstimateChargeIn":[0],"EstimateCost":0,"EstimateCostGreaterThanOrEqualTo":0,"EstimateCostGreaterThan":0,"EstimateCostLessThan":0,"EstimateCostLessThanOrEqualTo":0,"EstimateCostNotEqualTo":0,"EstimateCostBetween":[0],"EstimateCostIn":[0],"JobID":"String","JobIDStartsWith":"String","JobIDEndsWith":"String","JobIDContains":"String","JobIDLike":"String","JobIDBetween":["String"],"JobIDIn":["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":[{"EstimateCharge":0,"EstimateCost":0,"JobID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}