Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ImportQueueID | query | string | No | |
ImportQueueIDStartsWith | query | string | No | |
ImportQueueIDEndsWith | query | string | No | |
ImportQueueIDContains | query | string | No | |
ImportQueueIDLike | query | string | No | |
ImportQueueIDBetween | query | string[] | No | |
ImportQueueIDIn | query | string[] | No | |
OriginalXML | query | string | No | |
OriginalXMLStartsWith | query | string | No | |
OriginalXMLEndsWith | query | string | No | |
OriginalXMLContains | query | string | No | |
OriginalXMLLike | query | string | No | |
OriginalXMLBetween | query | string[] | No | |
OriginalXMLIn | query | string[] | No | |
TransformedXML | query | string | No | |
TransformedXMLStartsWith | query | string | No | |
TransformedXMLEndsWith | query | string | No | |
TransformedXMLContains | query | string | No | |
TransformedXMLLike | query | string | No | |
TransformedXMLBetween | query | string[] | No | |
TransformedXMLIn | query | string[] | No | |
Status | query | byte? | No | |
StatusGreaterThanOrEqualTo | query | byte? | No | |
StatusGreaterThan | query | byte? | No | |
StatusLessThan | query | byte? | No | |
StatusLessThanOrEqualTo | query | byte? | No | |
StatusNotEqualTo | query | byte? | No | |
StatusBetween | query | byte[] | No | |
StatusIn | query | byte[] | No | |
AddedToQueueDateTime | query | DateTime? | No | |
AddedToQueueDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
AddedToQueueDateTimeGreaterThan | query | DateTime? | No | |
AddedToQueueDateTimeLessThan | query | DateTime? | No | |
AddedToQueueDateTimeLessThanOrEqualTo | query | DateTime? | No | |
AddedToQueueDateTimeNotEqualTo | query | DateTime? | No | |
AddedToQueueDateTimeBetween | query | DateTime[] | No | |
AddedToQueueDateTimeIn | query | DateTime[] | No | |
AddedToQueueByStaffID | query | string | No | |
AddedToQueueByStaffIDStartsWith | query | string | No | |
AddedToQueueByStaffIDEndsWith | query | string | No | |
AddedToQueueByStaffIDContains | query | string | No | |
AddedToQueueByStaffIDLike | query | string | No | |
AddedToQueueByStaffIDBetween | query | string[] | No | |
AddedToQueueByStaffIDIn | 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 | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
LastSavedByStaffID | query | string | No | |
LastSavedByStaffIDStartsWith | query | string | No | |
LastSavedByStaffIDEndsWith | query | string | No | |
LastSavedByStaffIDContains | query | string | No | |
LastSavedByStaffIDLike | query | string | No | |
LastSavedByStaffIDBetween | query | string[] | No | |
LastSavedByStaffIDIn | query | string[] | No | |
ImportErrorMessage | query | string | No | |
ImportErrorMessageStartsWith | query | string | No | |
ImportErrorMessageEndsWith | query | string | No | |
ImportErrorMessageContains | query | string | No | |
ImportErrorMessageLike | query | string | No | |
ImportErrorMessageBetween | query | string[] | No | |
ImportErrorMessageIn | query | string[] | No | |
ImportBatchID | query | string | No | |
ImportBatchIDStartsWith | query | string | No | |
ImportBatchIDEndsWith | query | string | No | |
ImportBatchIDContains | query | string | No | |
ImportBatchIDLike | query | string | No | |
ImportBatchIDBetween | query | string[] | No | |
ImportBatchIDIn | query | string[] | No | |
BatchNo | query | string | No | |
BatchNoStartsWith | query | string | No | |
BatchNoEndsWith | query | string | No | |
BatchNoContains | query | string | No | |
BatchNoLike | query | string | No | |
BatchNoBetween | query | string[] | No | |
BatchNoIn | query | string[] | No | |
ItemNo | query | int? | No | |
ItemNoGreaterThanOrEqualTo | query | int? | No | |
ItemNoGreaterThan | query | int? | No | |
ItemNoLessThan | query | int? | No | |
ItemNoLessThanOrEqualTo | query | int? | No | |
ItemNoNotEqualTo | query | int? | No | |
ItemNoBetween | query | Nullable<Int32>[] | No | |
ItemNoIn | query | Nullable<Int32>[] | No | |
ImportSuccessMessage | query | string | No | |
ImportSuccessMessageStartsWith | query | string | No | |
ImportSuccessMessageEndsWith | query | string | No | |
ImportSuccessMessageContains | query | string | No | |
ImportSuccessMessageLike | query | string | No | |
ImportSuccessMessageBetween | query | string[] | No | |
ImportSuccessMessageIn | 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 |
---|---|---|---|---|
ImportQueueID | form | string | No | |
OriginalXML | form | string | No | |
TransformedXML | form | string | No | |
Status | form | byte | No | |
AddedToQueueDateTime | form | DateTime | No | |
AddedToQueueByStaffID | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
LastSavedByStaffID | form | string | No | |
ImportErrorMessage | form | string | No | |
ImportBatchID | form | string | No | |
BatchNo | form | string | No | |
ItemNo | form | int? | No | |
ImportSuccessMessage | 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/IM_ImportQueueQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ImportQueueID":"String","ImportQueueIDStartsWith":"String","ImportQueueIDEndsWith":"String","ImportQueueIDContains":"String","ImportQueueIDLike":"String","ImportQueueIDBetween":["String"],"ImportQueueIDIn":["String"],"OriginalXML":"String","OriginalXMLStartsWith":"String","OriginalXMLEndsWith":"String","OriginalXMLContains":"String","OriginalXMLLike":"String","OriginalXMLBetween":["String"],"OriginalXMLIn":["String"],"TransformedXML":"String","TransformedXMLStartsWith":"String","TransformedXMLEndsWith":"String","TransformedXMLContains":"String","TransformedXMLLike":"String","TransformedXMLBetween":["String"],"TransformedXMLIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","AddedToQueueDateTime":"0001-01-01T00:00:00.0000000","AddedToQueueDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","AddedToQueueDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","AddedToQueueDateTimeLessThan":"0001-01-01T00:00:00.0000000","AddedToQueueDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","AddedToQueueDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","AddedToQueueDateTimeBetween":["0001-01-01T00:00:00.0000000"],"AddedToQueueDateTimeIn":["0001-01-01T00:00:00.0000000"],"AddedToQueueByStaffID":"String","AddedToQueueByStaffIDStartsWith":"String","AddedToQueueByStaffIDEndsWith":"String","AddedToQueueByStaffIDContains":"String","AddedToQueueByStaffIDLike":"String","AddedToQueueByStaffIDBetween":["String"],"AddedToQueueByStaffIDIn":["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"],"LastSavedByStaffID":"String","LastSavedByStaffIDStartsWith":"String","LastSavedByStaffIDEndsWith":"String","LastSavedByStaffIDContains":"String","LastSavedByStaffIDLike":"String","LastSavedByStaffIDBetween":["String"],"LastSavedByStaffIDIn":["String"],"ImportErrorMessage":"String","ImportErrorMessageStartsWith":"String","ImportErrorMessageEndsWith":"String","ImportErrorMessageContains":"String","ImportErrorMessageLike":"String","ImportErrorMessageBetween":["String"],"ImportErrorMessageIn":["String"],"ImportBatchID":"String","ImportBatchIDStartsWith":"String","ImportBatchIDEndsWith":"String","ImportBatchIDContains":"String","ImportBatchIDLike":"String","ImportBatchIDBetween":["String"],"ImportBatchIDIn":["String"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"ImportSuccessMessage":"String","ImportSuccessMessageStartsWith":"String","ImportSuccessMessageEndsWith":"String","ImportSuccessMessageContains":"String","ImportSuccessMessageLike":"String","ImportSuccessMessageBetween":["String"],"ImportSuccessMessageIn":["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":[{"ImportQueueID":"String","OriginalXML":"String","TransformedXML":"String","AddedToQueueByStaffID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedByStaffID":"String","ImportErrorMessage":"String","ImportBatchID":"String","BatchNo":"String","ItemNo":0,"ImportSuccessMessage":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}