| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | 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 | |
| DB_Main_RecID | query | string | No | |
| DB_Main_RecIDStartsWith | query | string | No | |
| DB_Main_RecIDEndsWith | query | string | No | |
| DB_Main_RecIDContains | query | string | No | |
| DB_Main_RecIDLike | query | string | No | |
| DB_Main_RecIDBetween | query | string[] | No | |
| DB_Main_RecIDIn | query | string[] | No | |
| CN_Contact_RecID | query | string | No | |
| CN_Contact_RecIDStartsWith | query | string | No | |
| CN_Contact_RecIDEndsWith | query | string | No | |
| CN_Contact_RecIDContains | query | string | No | |
| CN_Contact_RecIDLike | query | string | No | |
| CN_Contact_RecIDBetween | query | string[] | No | |
| CN_Contact_RecIDIn | query | string[] | No | |
| Reference | query | string | No | |
| ReferenceStartsWith | query | string | No | |
| ReferenceEndsWith | query | string | No | |
| ReferenceContains | query | string | No | |
| ReferenceLike | query | string | No | |
| ReferenceBetween | query | string[] | No | |
| ReferenceIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| Coordinator_HR_Staff_RecID | query | string | No | |
| Coordinator_HR_Staff_RecIDStartsWith | query | string | No | |
| Coordinator_HR_Staff_RecIDEndsWith | query | string | No | |
| Coordinator_HR_Staff_RecIDContains | query | string | No | |
| Coordinator_HR_Staff_RecIDLike | query | string | No | |
| Coordinator_HR_Staff_RecIDBetween | query | string[] | No | |
| Coordinator_HR_Staff_RecIDIn | query | string[] | No | |
| DateLogged | query | DateTime? | No | |
| DateLoggedGreaterThanOrEqualTo | query | DateTime? | No | |
| DateLoggedGreaterThan | query | DateTime? | No | |
| DateLoggedLessThan | query | DateTime? | No | |
| DateLoggedLessThanOrEqualTo | query | DateTime? | No | |
| DateLoggedNotEqualTo | query | DateTime? | No | |
| DateLoggedBetween | query | DateTime[] | No | |
| DateLoggedIn | query | DateTime[] | 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 | |
| LastSaved_HR_Staff_RecID | query | string | No | |
| LastSaved_HR_Staff_RecIDStartsWith | query | string | No | |
| LastSaved_HR_Staff_RecIDEndsWith | query | string | No | |
| LastSaved_HR_Staff_RecIDContains | query | string | No | |
| LastSaved_HR_Staff_RecIDLike | query | string | No | |
| LastSaved_HR_Staff_RecIDBetween | query | string[] | No | |
| LastSaved_HR_Staff_RecIDIn | query | string[] | No | |
| IN_PriceSchemes_RecID | query | string | No | |
| IN_PriceSchemes_RecIDStartsWith | query | string | No | |
| IN_PriceSchemes_RecIDEndsWith | query | string | No | |
| IN_PriceSchemes_RecIDContains | query | string | No | |
| IN_PriceSchemes_RecIDLike | query | string | No | |
| IN_PriceSchemes_RecIDBetween | query | string[] | No | |
| IN_PriceSchemes_RecIDIn | query | string[] | No | |
| TaxExemptNo | query | string | No | |
| TaxExemptNoStartsWith | query | string | No | |
| TaxExemptNoEndsWith | query | string | No | |
| TaxExemptNoContains | query | string | No | |
| TaxExemptNoLike | query | string | No | |
| TaxExemptNoBetween | query | string[] | No | |
| TaxExemptNoIn | query | string[] | No | |
| RowHash | query | byte[] | No | |
| IN_LogicalID | query | string | No | |
| IN_LogicalIDStartsWith | query | string | No | |
| IN_LogicalIDEndsWith | query | string | No | |
| IN_LogicalIDContains | query | string | No | |
| IN_LogicalIDLike | query | string | No | |
| IN_LogicalIDBetween | query | string[] | No | |
| IN_LogicalIDIn | 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 |
|---|---|---|---|---|
| RecID | form | string | No | |
| JobNo | form | string | No | |
| DB_Main_RecID | form | string | No | |
| CN_Contact_RecID | form | string | No | |
| Reference | form | string | No | |
| Description | form | string | No | |
| Coordinator_HR_Staff_RecID | form | string | No | |
| DateLogged | form | DateTime | No | |
| LastSavedDateTime | form | DateTime | No | |
| LastSaved_HR_Staff_RecID | form | string | No | |
| IN_PriceSchemes_RecID | form | string | No | |
| TaxExemptNo | form | string | No | |
| RowHash | form | byte[] | No | |
| IN_LogicalID | 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/SM_JobsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"JobNo":"String","JobNoStartsWith":"String","JobNoEndsWith":"String","JobNoContains":"String","JobNoLike":"String","JobNoBetween":["String"],"JobNoIn":["String"],"DB_Main_RecID":"String","DB_Main_RecIDStartsWith":"String","DB_Main_RecIDEndsWith":"String","DB_Main_RecIDContains":"String","DB_Main_RecIDLike":"String","DB_Main_RecIDBetween":["String"],"DB_Main_RecIDIn":["String"],"CN_Contact_RecID":"String","CN_Contact_RecIDStartsWith":"String","CN_Contact_RecIDEndsWith":"String","CN_Contact_RecIDContains":"String","CN_Contact_RecIDLike":"String","CN_Contact_RecIDBetween":["String"],"CN_Contact_RecIDIn":["String"],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"Coordinator_HR_Staff_RecID":"String","Coordinator_HR_Staff_RecIDStartsWith":"String","Coordinator_HR_Staff_RecIDEndsWith":"String","Coordinator_HR_Staff_RecIDContains":"String","Coordinator_HR_Staff_RecIDLike":"String","Coordinator_HR_Staff_RecIDBetween":["String"],"Coordinator_HR_Staff_RecIDIn":["String"],"DateLogged":"0001-01-01T00:00:00.0000000","DateLoggedGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateLoggedGreaterThan":"0001-01-01T00:00:00.0000000","DateLoggedLessThan":"0001-01-01T00:00:00.0000000","DateLoggedLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateLoggedNotEqualTo":"0001-01-01T00:00:00.0000000","DateLoggedBetween":["0001-01-01T00:00:00.0000000"],"DateLoggedIn":["0001-01-01T00:00:00.0000000"],"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"],"LastSaved_HR_Staff_RecID":"String","LastSaved_HR_Staff_RecIDStartsWith":"String","LastSaved_HR_Staff_RecIDEndsWith":"String","LastSaved_HR_Staff_RecIDContains":"String","LastSaved_HR_Staff_RecIDLike":"String","LastSaved_HR_Staff_RecIDBetween":["String"],"LastSaved_HR_Staff_RecIDIn":["String"],"IN_PriceSchemes_RecID":"String","IN_PriceSchemes_RecIDStartsWith":"String","IN_PriceSchemes_RecIDEndsWith":"String","IN_PriceSchemes_RecIDContains":"String","IN_PriceSchemes_RecIDLike":"String","IN_PriceSchemes_RecIDBetween":["String"],"IN_PriceSchemes_RecIDIn":["String"],"TaxExemptNo":"String","TaxExemptNoStartsWith":"String","TaxExemptNoEndsWith":"String","TaxExemptNoContains":"String","TaxExemptNoLike":"String","TaxExemptNoBetween":["String"],"TaxExemptNoIn":["String"],"RowHash":"AA==","IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["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":[{"RecID":"String","JobNo":"String","DB_Main_RecID":"String","CN_Contact_RecID":"String","Reference":"String","Description":"String","Coordinator_HR_Staff_RecID":"String","LastSaved_HR_Staff_RecID":"String","IN_PriceSchemes_RecID":"String","TaxExemptNo":"String","RowHash":"AA==","IN_LogicalID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}