JiwaAPI

<back to all web services

Magento_QueueQuery

Requires Authentication
Magento_QueueQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
QueueNamequerystringNo
QueueNameStartsWithquerystringNo
QueueNameEndsWithquerystringNo
QueueNameContainsquerystringNo
QueueNameLikequerystringNo
QueueNameBetweenquerystring[]No
QueueNameInquerystring[]No
IdentifierquerystringNo
IdentifierStartsWithquerystringNo
IdentifierEndsWithquerystringNo
IdentifierContainsquerystringNo
IdentifierLikequerystringNo
IdentifierBetweenquerystring[]No
IdentifierInquerystring[]No
QueueInsertionDateTimequeryDateTime?No
QueueInsertionDateTimeGreaterThanOrEqualToqueryDateTime?No
QueueInsertionDateTimeGreaterThanqueryDateTime?No
QueueInsertionDateTimeLessThanqueryDateTime?No
QueueInsertionDateTimeLessThanOrEqualToqueryDateTime?No
QueueInsertionDateTimeNotEqualToqueryDateTime?No
QueueInsertionDateTimeBetweenqueryDateTime[]No
QueueInsertionDateTimeInqueryDateTime[]No
LastChangedDateTimequeryDateTime?No
LastChangedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastChangedDateTimeGreaterThanqueryDateTime?No
LastChangedDateTimeLessThanqueryDateTime?No
LastChangedDateTimeLessThanOrEqualToqueryDateTime?No
LastChangedDateTimeNotEqualToqueryDateTime?No
LastChangedDateTimeBetweenqueryDateTime[]No
LastChangedDateTimeInqueryDateTime[]No
Statusquerybyte?No
StatusGreaterThanOrEqualToquerybyte?No
StatusGreaterThanquerybyte?No
StatusLessThanquerybyte?No
StatusLessThanOrEqualToquerybyte?No
StatusNotEqualToquerybyte?No
StatusBetweenquerybyte[]No
StatusInquerybyte[]No
ExceptionTextquerystringNo
ExceptionTextStartsWithquerystringNo
ExceptionTextEndsWithquerystringNo
ExceptionTextContainsquerystringNo
ExceptionTextLikequerystringNo
ExceptionTextBetweenquerystring[]No
ExceptionTextInquerystring[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Magento_Queue Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
QueueNameformstringNo
IdentifierformstringNo
QueueInsertionDateTimeformDateTimeNo
LastChangedDateTimeformDateTimeNo
StatusformbyteNo
ExceptionTextformstringNo
RowHashformbyte[]No
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/Magento_QueueQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"QueueName":"String","QueueNameStartsWith":"String","QueueNameEndsWith":"String","QueueNameContains":"String","QueueNameLike":"String","QueueNameBetween":["String"],"QueueNameIn":["String"],"Identifier":"String","IdentifierStartsWith":"String","IdentifierEndsWith":"String","IdentifierContains":"String","IdentifierLike":"String","IdentifierBetween":["String"],"IdentifierIn":["String"],"QueueInsertionDateTime":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeLessThan":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeBetween":["0001-01-01T00:00:00.0000000"],"QueueInsertionDateTimeIn":["0001-01-01T00:00:00.0000000"],"LastChangedDateTime":"0001-01-01T00:00:00.0000000","LastChangedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastChangedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastChangedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastChangedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastChangedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastChangedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastChangedDateTimeIn":["0001-01-01T00:00:00.0000000"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","ExceptionText":"String","ExceptionTextStartsWith":"String","ExceptionTextEndsWith":"String","ExceptionTextContains":"String","ExceptionTextLike":"String","ExceptionTextBetween":["String"],"ExceptionTextIn":["String"],"RowHash":"AA==","Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"QueueName":"String","Identifier":"String","ExceptionText":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}