| 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 | |
| RecNum | query | string | No | |
| RecNumStartsWith | query | string | No | |
| RecNumEndsWith | query | string | No | |
| RecNumContains | query | string | No | |
| RecNumLike | query | string | No | |
| RecNumBetween | query | string[] | No | |
| RecNumIn | query | string[] | No | |
| RecDescription | query | string | No | |
| RecDescriptionStartsWith | query | string | No | |
| RecDescriptionEndsWith | query | string | No | |
| RecDescriptionContains | query | string | No | |
| RecDescriptionLike | query | string | No | |
| RecDescriptionBetween | query | string[] | No | |
| RecDescriptionIn | query | string[] | No | |
| RecType | query | short? | No | |
| RecTypeGreaterThanOrEqualTo | query | short? | No | |
| RecTypeGreaterThan | query | short? | No | |
| RecTypeLessThan | query | short? | No | |
| RecTypeLessThanOrEqualTo | query | short? | No | |
| RecTypeNotEqualTo | query | short? | No | |
| RecTypeBetween | query | Nullable<Int16>[] | No | |
| RecTypeIn | query | Nullable<Int16>[] | No | |
| RecGroup | query | string | No | |
| RecGroupStartsWith | query | string | No | |
| RecGroupEndsWith | query | string | No | |
| RecGroupContains | query | string | No | |
| RecGroupLike | query | string | No | |
| RecGroupBetween | query | string[] | No | |
| RecGroupIn | query | string[] | 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 | |
| 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 | |
| Unit | query | string | No | |
| UnitStartsWith | query | string | No | |
| UnitEndsWith | query | string | No | |
| UnitContains | query | string | No | |
| UnitLike | query | string | No | |
| UnitBetween | query | string[] | No | |
| UnitIn | query | string[] | No | |
| Status | query | bool? | No | |
| Note | query | string | No | |
| NoteStartsWith | query | string | No | |
| NoteEndsWith | query | string | No | |
| NoteContains | query | string | No | |
| NoteLike | query | string | No | |
| NoteBetween | query | string[] | No | |
| NoteIn | query | string[] | 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 | |
| GLCode | query | string | No | |
| GLCodeStartsWith | query | string | No | |
| GLCodeEndsWith | query | string | No | |
| GLCodeContains | query | string | No | |
| GLCodeLike | query | string | No | |
| GLCodeBetween | query | string[] | No | |
| GLCodeIn | 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 | |
| RecNum | form | string | No | |
| RecDescription | form | string | No | |
| RecType | form | short? | No | |
| RecGroup | form | string | No | |
| Cost | form | decimal? | No | |
| Charge | form | decimal? | No | |
| Unit | form | string | No | |
| Status | form | bool? | No | |
| Note | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| GLCode | 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/JB_ResourcesQuery 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"],"RecNum":"String","RecNumStartsWith":"String","RecNumEndsWith":"String","RecNumContains":"String","RecNumLike":"String","RecNumBetween":["String"],"RecNumIn":["String"],"RecDescription":"String","RecDescriptionStartsWith":"String","RecDescriptionEndsWith":"String","RecDescriptionContains":"String","RecDescriptionLike":"String","RecDescriptionBetween":["String"],"RecDescriptionIn":["String"],"RecType":0,"RecTypeGreaterThanOrEqualTo":0,"RecTypeGreaterThan":0,"RecTypeLessThan":0,"RecTypeLessThanOrEqualTo":0,"RecTypeNotEqualTo":0,"RecTypeBetween":[0],"RecTypeIn":[0],"RecGroup":"String","RecGroupStartsWith":"String","RecGroupEndsWith":"String","RecGroupContains":"String","RecGroupLike":"String","RecGroupBetween":["String"],"RecGroupIn":["String"],"Cost":0,"CostGreaterThanOrEqualTo":0,"CostGreaterThan":0,"CostLessThan":0,"CostLessThanOrEqualTo":0,"CostNotEqualTo":0,"CostBetween":[0],"CostIn":[0],"Charge":0,"ChargeGreaterThanOrEqualTo":0,"ChargeGreaterThan":0,"ChargeLessThan":0,"ChargeLessThanOrEqualTo":0,"ChargeNotEqualTo":0,"ChargeBetween":[0],"ChargeIn":[0],"Unit":"String","UnitStartsWith":"String","UnitEndsWith":"String","UnitContains":"String","UnitLike":"String","UnitBetween":["String"],"UnitIn":["String"],"Status":false,"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["String"],"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"],"GLCode":"String","GLCodeStartsWith":"String","GLCodeEndsWith":"String","GLCodeContains":"String","GLCodeLike":"String","GLCodeBetween":["String"],"GLCodeIn":["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","RecNum":"String","RecDescription":"String","RecType":0,"RecGroup":"String","Cost":0,"Charge":0,"Unit":"String","Status":false,"Note":"String","GLCode":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}