Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 | |
JobNo | query | string | No | |
JobNoStartsWith | query | string | No | |
JobNoEndsWith | query | string | No | |
JobNoContains | query | string | No | |
JobNoLike | query | string | No | |
JobNoBetween | query | string[] | No | |
JobNoIn | query | string[] | No | |
JobDescription | query | string | No | |
JobDescriptionStartsWith | query | string | No | |
JobDescriptionEndsWith | query | string | No | |
JobDescriptionContains | query | string | No | |
JobDescriptionLike | query | string | No | |
JobDescriptionBetween | query | string[] | No | |
JobDescriptionIn | query | string[] | No | |
CostCentreID | query | string | No | |
CostCentreIDStartsWith | query | string | No | |
CostCentreIDEndsWith | query | string | No | |
CostCentreIDContains | query | string | No | |
CostCentreIDLike | query | string | No | |
CostCentreIDBetween | query | string[] | No | |
CostCentreIDIn | query | string[] | No | |
CostCentreNo | query | string | No | |
CostCentreNoStartsWith | query | string | No | |
CostCentreNoEndsWith | query | string | No | |
CostCentreNoContains | query | string | No | |
CostCentreNoLike | query | string | No | |
CostCentreNoBetween | query | string[] | No | |
CostCentreNoIn | query | string[] | No | |
CostCentreDesc | query | string | No | |
CostCentreDescStartsWith | query | string | No | |
CostCentreDescEndsWith | query | string | No | |
CostCentreDescContains | query | string | No | |
CostCentreDescLike | query | string | No | |
CostCentreDescBetween | query | string[] | No | |
CostCentreDescIn | query | string[] | No | |
StageID | query | string | No | |
StageIDStartsWith | query | string | No | |
StageIDEndsWith | query | string | No | |
StageIDContains | query | string | No | |
StageIDLike | query | string | No | |
StageIDBetween | query | string[] | No | |
StageIDIn | query | string[] | No | |
StageNo | query | string | No | |
StageNoStartsWith | query | string | No | |
StageNoEndsWith | query | string | No | |
StageNoContains | query | string | No | |
StageNoLike | query | string | No | |
StageNoBetween | query | string[] | No | |
StageNoIn | query | string[] | No | |
StageDesc | query | string | No | |
StageDescStartsWith | query | string | No | |
StageDescEndsWith | query | string | No | |
StageDescContains | query | string | No | |
StageDescLike | query | string | No | |
StageDescBetween | query | string[] | No | |
StageDescIn | 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 |
---|---|---|---|---|
JobID | form | string | No | |
JobNo | form | string | No | |
JobDescription | form | string | No | |
CostCentreID | form | string | No | |
CostCentreNo | form | string | No | |
CostCentreDesc | form | string | No | |
StageID | form | string | No | |
StageNo | form | string | No | |
StageDesc | 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_JobCodeSearchQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"JobID":"String","JobIDStartsWith":"String","JobIDEndsWith":"String","JobIDContains":"String","JobIDLike":"String","JobIDBetween":["String"],"JobIDIn":["String"],"JobNo":"String","JobNoStartsWith":"String","JobNoEndsWith":"String","JobNoContains":"String","JobNoLike":"String","JobNoBetween":["String"],"JobNoIn":["String"],"JobDescription":"String","JobDescriptionStartsWith":"String","JobDescriptionEndsWith":"String","JobDescriptionContains":"String","JobDescriptionLike":"String","JobDescriptionBetween":["String"],"JobDescriptionIn":["String"],"CostCentreID":"String","CostCentreIDStartsWith":"String","CostCentreIDEndsWith":"String","CostCentreIDContains":"String","CostCentreIDLike":"String","CostCentreIDBetween":["String"],"CostCentreIDIn":["String"],"CostCentreNo":"String","CostCentreNoStartsWith":"String","CostCentreNoEndsWith":"String","CostCentreNoContains":"String","CostCentreNoLike":"String","CostCentreNoBetween":["String"],"CostCentreNoIn":["String"],"CostCentreDesc":"String","CostCentreDescStartsWith":"String","CostCentreDescEndsWith":"String","CostCentreDescContains":"String","CostCentreDescLike":"String","CostCentreDescBetween":["String"],"CostCentreDescIn":["String"],"StageID":"String","StageIDStartsWith":"String","StageIDEndsWith":"String","StageIDContains":"String","StageIDLike":"String","StageIDBetween":["String"],"StageIDIn":["String"],"StageNo":"String","StageNoStartsWith":"String","StageNoEndsWith":"String","StageNoContains":"String","StageNoLike":"String","StageNoBetween":["String"],"StageNoIn":["String"],"StageDesc":"String","StageDescStartsWith":"String","StageDescEndsWith":"String","StageDescContains":"String","StageDescLike":"String","StageDescBetween":["String"],"StageDescIn":["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":[{"JobID":"String","JobNo":"String","JobDescription":"String","CostCentreID":"String","CostCentreNo":"String","CostCentreDesc":"String","StageID":"String","StageNo":"String","StageDesc":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}