JiwaAPI

<back to all web services

IM_ImportQueueQuery

Requires Authentication
IM_ImportQueueQuery Parameters:
NameParameterData TypeRequiredDescription
ImportQueueIDquerystringNo
ImportQueueIDStartsWithquerystringNo
ImportQueueIDEndsWithquerystringNo
ImportQueueIDContainsquerystringNo
ImportQueueIDLikequerystringNo
ImportQueueIDBetweenquerystring[]No
ImportQueueIDInquerystring[]No
OriginalXMLquerystringNo
OriginalXMLStartsWithquerystringNo
OriginalXMLEndsWithquerystringNo
OriginalXMLContainsquerystringNo
OriginalXMLLikequerystringNo
OriginalXMLBetweenquerystring[]No
OriginalXMLInquerystring[]No
TransformedXMLquerystringNo
TransformedXMLStartsWithquerystringNo
TransformedXMLEndsWithquerystringNo
TransformedXMLContainsquerystringNo
TransformedXMLLikequerystringNo
TransformedXMLBetweenquerystring[]No
TransformedXMLInquerystring[]No
Statusquerybyte?No
StatusGreaterThanOrEqualToquerybyte?No
StatusGreaterThanquerybyte?No
StatusLessThanquerybyte?No
StatusLessThanOrEqualToquerybyte?No
StatusNotEqualToquerybyte?No
StatusBetweenquerybyte[]No
StatusInquerybyte[]No
AddedToQueueDateTimequeryDateTime?No
AddedToQueueDateTimeGreaterThanOrEqualToqueryDateTime?No
AddedToQueueDateTimeGreaterThanqueryDateTime?No
AddedToQueueDateTimeLessThanqueryDateTime?No
AddedToQueueDateTimeLessThanOrEqualToqueryDateTime?No
AddedToQueueDateTimeNotEqualToqueryDateTime?No
AddedToQueueDateTimeBetweenqueryDateTime[]No
AddedToQueueDateTimeInqueryDateTime[]No
AddedToQueueByStaffIDquerystringNo
AddedToQueueByStaffIDStartsWithquerystringNo
AddedToQueueByStaffIDEndsWithquerystringNo
AddedToQueueByStaffIDContainsquerystringNo
AddedToQueueByStaffIDLikequerystringNo
AddedToQueueByStaffIDBetweenquerystring[]No
AddedToQueueByStaffIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
LastSavedByStaffIDquerystringNo
LastSavedByStaffIDStartsWithquerystringNo
LastSavedByStaffIDEndsWithquerystringNo
LastSavedByStaffIDContainsquerystringNo
LastSavedByStaffIDLikequerystringNo
LastSavedByStaffIDBetweenquerystring[]No
LastSavedByStaffIDInquerystring[]No
ImportErrorMessagequerystringNo
ImportErrorMessageStartsWithquerystringNo
ImportErrorMessageEndsWithquerystringNo
ImportErrorMessageContainsquerystringNo
ImportErrorMessageLikequerystringNo
ImportErrorMessageBetweenquerystring[]No
ImportErrorMessageInquerystring[]No
ImportBatchIDquerystringNo
ImportBatchIDStartsWithquerystringNo
ImportBatchIDEndsWithquerystringNo
ImportBatchIDContainsquerystringNo
ImportBatchIDLikequerystringNo
ImportBatchIDBetweenquerystring[]No
ImportBatchIDInquerystring[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryNullable<Int32>[]No
ItemNoInqueryNullable<Int32>[]No
ImportSuccessMessagequerystringNo
ImportSuccessMessageStartsWithquerystringNo
ImportSuccessMessageEndsWithquerystringNo
ImportSuccessMessageContainsquerystringNo
ImportSuccessMessageLikequerystringNo
ImportSuccessMessageBetweenquerystring[]No
ImportSuccessMessageInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IM_ImportQueue Parameters:
NameParameterData TypeRequiredDescription
ImportQueueIDformstringNo
OriginalXMLformstringNo
TransformedXMLformstringNo
StatusformbyteNo
AddedToQueueDateTimeformDateTimeNo
AddedToQueueByStaffIDformstringNo
LastSavedDateTimeformDateTime?No
LastSavedByStaffIDformstringNo
ImportErrorMessageformstringNo
ImportBatchIDformstringNo
BatchNoformstringNo
ItemNoformint?No
ImportSuccessMessageformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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"}}}