Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EmailLogID | query | string | No | |
EmailLogIDStartsWith | query | string | No | |
EmailLogIDEndsWith | query | string | No | |
EmailLogIDContains | query | string | No | |
EmailLogIDLike | query | string | No | |
EmailLogIDBetween | query | string[] | No | |
EmailLogIDIn | 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 | |
EmailDateTime | query | DateTime? | No | |
EmailDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
EmailDateTimeGreaterThan | query | DateTime? | No | |
EmailDateTimeLessThan | query | DateTime? | No | |
EmailDateTimeLessThanOrEqualTo | query | DateTime? | No | |
EmailDateTimeNotEqualTo | query | DateTime? | No | |
EmailDateTimeBetween | query | DateTime[] | No | |
EmailDateTimeIn | query | DateTime[] | No | |
From | query | string | No | |
FromStartsWith | query | string | No | |
FromEndsWith | query | string | No | |
FromContains | query | string | No | |
FromLike | query | string | No | |
FromBetween | query | string[] | No | |
FromIn | query | string[] | No | |
To | query | string | No | |
ToStartsWith | query | string | No | |
ToEndsWith | query | string | No | |
ToContains | query | string | No | |
ToLike | query | string | No | |
ToBetween | query | string[] | No | |
ToIn | query | string[] | No | |
CC | query | string | No | |
CCStartsWith | query | string | No | |
CCEndsWith | query | string | No | |
CCContains | query | string | No | |
CCLike | query | string | No | |
CCBetween | query | string[] | No | |
CCIn | query | string[] | No | |
BCC | query | string | No | |
BCCStartsWith | query | string | No | |
BCCEndsWith | query | string | No | |
BCCContains | query | string | No | |
BCCLike | query | string | No | |
BCCBetween | query | string[] | No | |
BCCIn | query | string[] | No | |
Attachments | query | string | No | |
AttachmentsStartsWith | query | string | No | |
AttachmentsEndsWith | query | string | No | |
AttachmentsContains | query | string | No | |
AttachmentsLike | query | string | No | |
AttachmentsBetween | query | string[] | No | |
AttachmentsIn | query | string[] | No | |
FileID | query | string | No | |
FileIDStartsWith | query | string | No | |
FileIDEndsWith | query | string | No | |
FileIDContains | query | string | No | |
FileIDLike | query | string | No | |
FileIDBetween | query | string[] | No | |
FileIDIn | query | string[] | No | |
Subject | query | string | No | |
SubjectStartsWith | query | string | No | |
SubjectEndsWith | query | string | No | |
SubjectContains | query | string | No | |
SubjectLike | query | string | No | |
SubjectBetween | query | string[] | No | |
SubjectIn | query | string[] | No | |
Body | query | string | No | |
BodyStartsWith | query | string | No | |
BodyEndsWith | query | string | No | |
BodyContains | query | string | No | |
BodyLike | query | string | No | |
BodyBetween | query | string[] | No | |
BodyIn | 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 | |
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 | |
EM_Main_RecID | query | string | No | |
EM_Main_RecIDStartsWith | query | string | No | |
EM_Main_RecIDEndsWith | query | string | No | |
EM_Main_RecIDContains | query | string | No | |
EM_Main_RecIDLike | query | string | No | |
EM_Main_RecIDBetween | query | string[] | No | |
EM_Main_RecIDIn | query | string[] | No | |
RequestReadReceipt | query | bool? | 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 |
---|---|---|---|---|
EmailLogID | form | string | No | |
InvoiceHistoryID | form | string | No | |
EmailDateTime | form | DateTime | No | |
From | form | string | No | |
To | form | string | No | |
CC | form | string | No | |
BCC | form | string | No | |
Attachments | form | string | No | |
FileID | form | string | No | |
Subject | form | string | No | |
Body | form | string | No | |
InvoiceID | form | string | No | |
StaffID | form | string | No | |
EM_Main_RecID | form | string | No | |
RequestReadReceipt | form | bool? | 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/QO_EmailLogQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"EmailLogID":"String","EmailLogIDStartsWith":"String","EmailLogIDEndsWith":"String","EmailLogIDContains":"String","EmailLogIDLike":"String","EmailLogIDBetween":["String"],"EmailLogIDIn":["String"],"InvoiceHistoryID":"String","InvoiceHistoryIDStartsWith":"String","InvoiceHistoryIDEndsWith":"String","InvoiceHistoryIDContains":"String","InvoiceHistoryIDLike":"String","InvoiceHistoryIDBetween":["String"],"InvoiceHistoryIDIn":["String"],"EmailDateTime":"0001-01-01T00:00:00.0000000","EmailDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EmailDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","EmailDateTimeLessThan":"0001-01-01T00:00:00.0000000","EmailDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EmailDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","EmailDateTimeBetween":["0001-01-01T00:00:00.0000000"],"EmailDateTimeIn":["0001-01-01T00:00:00.0000000"],"From":"String","FromStartsWith":"String","FromEndsWith":"String","FromContains":"String","FromLike":"String","FromBetween":["String"],"FromIn":["String"],"To":"String","ToStartsWith":"String","ToEndsWith":"String","ToContains":"String","ToLike":"String","ToBetween":["String"],"ToIn":["String"],"CC":"String","CCStartsWith":"String","CCEndsWith":"String","CCContains":"String","CCLike":"String","CCBetween":["String"],"CCIn":["String"],"BCC":"String","BCCStartsWith":"String","BCCEndsWith":"String","BCCContains":"String","BCCLike":"String","BCCBetween":["String"],"BCCIn":["String"],"Attachments":"String","AttachmentsStartsWith":"String","AttachmentsEndsWith":"String","AttachmentsContains":"String","AttachmentsLike":"String","AttachmentsBetween":["String"],"AttachmentsIn":["String"],"FileID":"String","FileIDStartsWith":"String","FileIDEndsWith":"String","FileIDContains":"String","FileIDLike":"String","FileIDBetween":["String"],"FileIDIn":["String"],"Subject":"String","SubjectStartsWith":"String","SubjectEndsWith":"String","SubjectContains":"String","SubjectLike":"String","SubjectBetween":["String"],"SubjectIn":["String"],"Body":"String","BodyStartsWith":"String","BodyEndsWith":"String","BodyContains":"String","BodyLike":"String","BodyBetween":["String"],"BodyIn":["String"],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"EM_Main_RecID":"String","EM_Main_RecIDStartsWith":"String","EM_Main_RecIDEndsWith":"String","EM_Main_RecIDContains":"String","EM_Main_RecIDLike":"String","EM_Main_RecIDBetween":["String"],"EM_Main_RecIDIn":["String"],"RequestReadReceipt":false,"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":[{"EmailLogID":"String","InvoiceHistoryID":"String","From":"String","To":"String","CC":"String","BCC":"String","Attachments":"String","FileID":"String","Subject":"String","Body":"String","InvoiceID":"String","StaffID":"String","EM_Main_RecID":"String","RequestReadReceipt":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}