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 | |
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 | |
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 | |
Status | query | short? | No | |
StatusGreaterThanOrEqualTo | query | short? | No | |
StatusGreaterThan | query | short? | No | |
StatusLessThan | query | short? | No | |
StatusLessThanOrEqualTo | query | short? | No | |
StatusNotEqualTo | query | short? | No | |
StatusBetween | query | Nullable<Int16>[] | No | |
StatusIn | query | Nullable<Int16>[] | No | |
WarehouseID | query | string | No | |
WarehouseIDStartsWith | query | string | No | |
WarehouseIDEndsWith | query | string | No | |
WarehouseIDContains | query | string | No | |
WarehouseIDLike | query | string | No | |
WarehouseIDBetween | query | string[] | No | |
WarehouseIDIn | 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 | |
EntryType | query | short? | No | |
EntryTypeGreaterThanOrEqualTo | query | short? | No | |
EntryTypeGreaterThan | query | short? | No | |
EntryTypeLessThan | query | short? | No | |
EntryTypeLessThanOrEqualTo | query | short? | No | |
EntryTypeNotEqualTo | query | short? | No | |
EntryTypeBetween | query | Nullable<Int16>[] | No | |
EntryTypeIn | query | Nullable<Int16>[] | 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 | |
JrnlSetID | query | string | No | |
JrnlSetIDStartsWith | query | string | No | |
JrnlSetIDEndsWith | query | string | No | |
JrnlSetIDContains | query | string | No | |
JrnlSetIDLike | query | string | No | |
JrnlSetIDBetween | query | string[] | No | |
JrnlSetIDIn | 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 | |
Reference | form | string | No | |
Note | form | string | No | |
Status | form | short? | No | |
WarehouseID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
EntryType | form | short? | No | |
JobID | form | string | No | |
JrnlSetID | 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_CostEntryQuery 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"],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"WarehouseID":"String","WarehouseIDStartsWith":"String","WarehouseIDEndsWith":"String","WarehouseIDContains":"String","WarehouseIDLike":"String","WarehouseIDBetween":["String"],"WarehouseIDIn":["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"],"EntryType":0,"EntryTypeGreaterThanOrEqualTo":0,"EntryTypeGreaterThan":0,"EntryTypeLessThan":0,"EntryTypeLessThanOrEqualTo":0,"EntryTypeNotEqualTo":0,"EntryTypeBetween":[0],"EntryTypeIn":[0],"JobID":"String","JobIDStartsWith":"String","JobIDEndsWith":"String","JobIDContains":"String","JobIDLike":"String","JobIDBetween":["String"],"JobIDIn":["String"],"JrnlSetID":"String","JrnlSetIDStartsWith":"String","JrnlSetIDEndsWith":"String","JrnlSetIDContains":"String","JrnlSetIDLike":"String","JrnlSetIDBetween":["String"],"JrnlSetIDIn":["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","Reference":"String","Note":"String","Status":0,"WarehouseID":"String","EntryType":0,"JobID":"String","JrnlSetID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}