JiwaAPI

<back to all web services

EX_ExportQueueQuery

Requires Authentication
EX_ExportQueueQuery Parameters:
NameParameterData TypeRequiredDescription
ExportQueueIDquerystringNo
ExportQueueIDStartsWithquerystringNo
ExportQueueIDEndsWithquerystringNo
ExportQueueIDContainsquerystringNo
ExportQueueIDLikequerystringNo
ExportQueueIDBetweenquerystring[]No
ExportQueueIDInquerystring[]No
ExportDataquerystringNo
ExportDataStartsWithquerystringNo
ExportDataEndsWithquerystringNo
ExportDataContainsquerystringNo
ExportDataLikequerystringNo
ExportDataBetweenquerystring[]No
ExportDataInquerystring[]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
ExportErrorMessagequerystringNo
ExportErrorMessageStartsWithquerystringNo
ExportErrorMessageEndsWithquerystringNo
ExportErrorMessageContainsquerystringNo
ExportErrorMessageLikequerystringNo
ExportErrorMessageBetweenquerystring[]No
ExportErrorMessageInquerystring[]No
ExportBatchIDquerystringNo
ExportBatchIDStartsWithquerystringNo
ExportBatchIDEndsWithquerystringNo
ExportBatchIDContainsquerystringNo
ExportBatchIDLikequerystringNo
ExportBatchIDBetweenquerystring[]No
ExportBatchIDInquerystring[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
ItemNoquerystringNo
ItemNoStartsWithquerystringNo
ItemNoEndsWithquerystringNo
ItemNoContainsquerystringNo
ItemNoLikequerystringNo
ItemNoBetweenquerystring[]No
ItemNoInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
EX_ExportQueue Parameters:
NameParameterData TypeRequiredDescription
ExportQueueIDformstringNo
ExportDataformstringNo
StatusformbyteNo
AddedToQueueDateTimeformDateTimeNo
AddedToQueueByStaffIDformstringNo
LastSavedDateTimeformDateTime?No
LastSavedByStaffIDformstringNo
ExportErrorMessageformstringNo
ExportBatchIDformstringNo
BatchNoformstringNo
ItemNoformstringNo
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/EX_ExportQueueQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ExportQueueID":"String","ExportQueueIDStartsWith":"String","ExportQueueIDEndsWith":"String","ExportQueueIDContains":"String","ExportQueueIDLike":"String","ExportQueueIDBetween":["String"],"ExportQueueIDIn":["String"],"ExportData":"String","ExportDataStartsWith":"String","ExportDataEndsWith":"String","ExportDataContains":"String","ExportDataLike":"String","ExportDataBetween":["String"],"ExportDataIn":["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"],"ExportErrorMessage":"String","ExportErrorMessageStartsWith":"String","ExportErrorMessageEndsWith":"String","ExportErrorMessageContains":"String","ExportErrorMessageLike":"String","ExportErrorMessageBetween":["String"],"ExportErrorMessageIn":["String"],"ExportBatchID":"String","ExportBatchIDStartsWith":"String","ExportBatchIDEndsWith":"String","ExportBatchIDContains":"String","ExportBatchIDLike":"String","ExportBatchIDBetween":["String"],"ExportBatchIDIn":["String"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"ItemNo":"String","ItemNoStartsWith":"String","ItemNoEndsWith":"String","ItemNoContains":"String","ItemNoLike":"String","ItemNoBetween":["String"],"ItemNoIn":["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":[{"ExportQueueID":"String","ExportData":"String","AddedToQueueByStaffID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedByStaffID":"String","ExportErrorMessage":"String","ExportBatchID":"String","BatchNo":"String","ItemNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}