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 .xml suffix or ?format=xml

HTTP + XML

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

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

<Magento_QueueQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <ExceptionText>String</ExceptionText>
  <ExceptionTextBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ExceptionTextBetween>
  <ExceptionTextContains>String</ExceptionTextContains>
  <ExceptionTextEndsWith>String</ExceptionTextEndsWith>
  <ExceptionTextIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ExceptionTextIn>
  <ExceptionTextLike>String</ExceptionTextLike>
  <ExceptionTextStartsWith>String</ExceptionTextStartsWith>
  <Identifier>String</Identifier>
  <IdentifierBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IdentifierBetween>
  <IdentifierContains>String</IdentifierContains>
  <IdentifierEndsWith>String</IdentifierEndsWith>
  <IdentifierIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IdentifierIn>
  <IdentifierLike>String</IdentifierLike>
  <IdentifierStartsWith>String</IdentifierStartsWith>
  <LastChangedDateTime>0001-01-01T00:00:00</LastChangedDateTime>
  <LastChangedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastChangedDateTimeBetween>
  <LastChangedDateTimeGreaterThan>0001-01-01T00:00:00</LastChangedDateTimeGreaterThan>
  <LastChangedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastChangedDateTimeGreaterThanOrEqualTo>
  <LastChangedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastChangedDateTimeIn>
  <LastChangedDateTimeLessThan>0001-01-01T00:00:00</LastChangedDateTimeLessThan>
  <LastChangedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastChangedDateTimeLessThanOrEqualTo>
  <LastChangedDateTimeNotEqualTo>0001-01-01T00:00:00</LastChangedDateTimeNotEqualTo>
  <QueueInsertionDateTime>0001-01-01T00:00:00</QueueInsertionDateTime>
  <QueueInsertionDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </QueueInsertionDateTimeBetween>
  <QueueInsertionDateTimeGreaterThan>0001-01-01T00:00:00</QueueInsertionDateTimeGreaterThan>
  <QueueInsertionDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</QueueInsertionDateTimeGreaterThanOrEqualTo>
  <QueueInsertionDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </QueueInsertionDateTimeIn>
  <QueueInsertionDateTimeLessThan>0001-01-01T00:00:00</QueueInsertionDateTimeLessThan>
  <QueueInsertionDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</QueueInsertionDateTimeLessThanOrEqualTo>
  <QueueInsertionDateTimeNotEqualTo>0001-01-01T00:00:00</QueueInsertionDateTimeNotEqualTo>
  <QueueName>String</QueueName>
  <QueueNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </QueueNameBetween>
  <QueueNameContains>String</QueueNameContains>
  <QueueNameEndsWith>String</QueueNameEndsWith>
  <QueueNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </QueueNameIn>
  <QueueNameLike>String</QueueNameLike>
  <QueueNameStartsWith>String</QueueNameStartsWith>
  <RecID>00000000-0000-0000-0000-000000000000</RecID>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </RecIDIn>
  <RowHash>AA==</RowHash>
  <Status>0</Status>
  <StatusBetween>AA==</StatusBetween>
  <StatusGreaterThan>0</StatusGreaterThan>
  <StatusGreaterThanOrEqualTo>0</StatusGreaterThanOrEqualTo>
  <StatusIn>AA==</StatusIn>
  <StatusLessThan>0</StatusLessThan>
  <StatusLessThanOrEqualTo>0</StatusLessThanOrEqualTo>
  <StatusNotEqualTo>0</StatusNotEqualTo>
</Magento_QueueQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfMagento_Queue7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:Magento_Queue>
      <d2p1:_x003C_ExceptionText_x003E_k__BackingField>String</d2p1:_x003C_ExceptionText_x003E_k__BackingField>
      <d2p1:_x003C_Identifier_x003E_k__BackingField>String</d2p1:_x003C_Identifier_x003E_k__BackingField>
      <d2p1:_x003C_LastChangedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastChangedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_QueueInsertionDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_QueueInsertionDateTime_x003E_k__BackingField>
      <d2p1:_x003C_QueueName_x003E_k__BackingField>String</d2p1:_x003C_QueueName_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField>
    </d2p1:Magento_Queue>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfMagento_Queue7kRqkrSv>