Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PrintLogID | query | string | No | |
PrintLogIDStartsWith | query | string | No | |
PrintLogIDEndsWith | query | string | No | |
PrintLogIDContains | query | string | No | |
PrintLogIDLike | query | string | No | |
PrintLogIDBetween | query | string[] | No | |
PrintLogIDIn | query | string[] | No | |
InvoiceID | query | string | No | |
InvoiceIDStartsWith | query | string | No | |
InvoiceIDEndsWith | query | string | No | |
InvoiceIDContains | query | string | No | |
InvoiceIDLike | query | string | No | |
InvoiceIDBetween | query | string[] | No | |
InvoiceIDIn | query | string[] | No | |
SysDateTime | query | DateTime? | No | |
SysDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
SysDateTimeGreaterThan | query | DateTime? | No | |
SysDateTimeLessThan | query | DateTime? | No | |
SysDateTimeLessThanOrEqualTo | query | DateTime? | No | |
SysDateTimeNotEqualTo | query | DateTime? | No | |
SysDateTimeBetween | query | DateTime[] | No | |
SysDateTimeIn | query | DateTime[] | 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 | |
InvoiceHistoryID | query | string | No | |
InvoiceHistoryIDStartsWith | query | string | No | |
InvoiceHistoryIDEndsWith | query | string | No | |
InvoiceHistoryIDContains | query | string | No | |
InvoiceHistoryIDLike | query | string | No | |
InvoiceHistoryIDBetween | query | string[] | No | |
InvoiceHistoryIDIn | query | string[] | No | |
ReportType | query | short? | No | |
ReportTypeGreaterThanOrEqualTo | query | short? | No | |
ReportTypeGreaterThan | query | short? | No | |
ReportTypeLessThan | query | short? | No | |
ReportTypeLessThanOrEqualTo | query | short? | No | |
ReportTypeNotEqualTo | query | short? | No | |
ReportTypeBetween | query | Nullable<Int16>[] | No | |
ReportTypeIn | query | Nullable<Int16>[] | No | |
StaffID | query | string | No | |
StaffIDStartsWith | query | string | No | |
StaffIDEndsWith | query | string | No | |
StaffIDContains | query | string | No | |
StaffIDLike | query | string | No | |
StaffIDBetween | query | string[] | No | |
StaffIDIn | 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 |
---|---|---|---|---|
PrintLogID | form | string | No | |
InvoiceID | form | string | No | |
SysDateTime | form | DateTime | No | |
Description | form | string | No | |
InvoiceHistoryID | form | string | No | |
ReportType | form | short? | No | |
StaffID | 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/SO_PrintLogQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"PrintLogID":"String","PrintLogIDStartsWith":"String","PrintLogIDEndsWith":"String","PrintLogIDContains":"String","PrintLogIDLike":"String","PrintLogIDBetween":["String"],"PrintLogIDIn":["String"],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"SysDateTime":"0001-01-01T00:00:00.0000000","SysDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","SysDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","SysDateTimeLessThan":"0001-01-01T00:00:00.0000000","SysDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","SysDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","SysDateTimeBetween":["0001-01-01T00:00:00.0000000"],"SysDateTimeIn":["0001-01-01T00:00:00.0000000"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"InvoiceHistoryID":"String","InvoiceHistoryIDStartsWith":"String","InvoiceHistoryIDEndsWith":"String","InvoiceHistoryIDContains":"String","InvoiceHistoryIDLike":"String","InvoiceHistoryIDBetween":["String"],"InvoiceHistoryIDIn":["String"],"ReportType":0,"ReportTypeGreaterThanOrEqualTo":0,"ReportTypeGreaterThan":0,"ReportTypeLessThan":0,"ReportTypeLessThanOrEqualTo":0,"ReportTypeNotEqualTo":0,"ReportTypeBetween":[0],"ReportTypeIn":[0],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["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":[{"PrintLogID":"String","InvoiceID":"String","Description":"String","InvoiceHistoryID":"String","ReportType":0,"StaffID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}