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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/IM_ImportQueueQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<IM_ImportQueueQuery 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>
<AddedToQueueByStaffID>String</AddedToQueueByStaffID>
<AddedToQueueByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AddedToQueueByStaffIDBetween>
<AddedToQueueByStaffIDContains>String</AddedToQueueByStaffIDContains>
<AddedToQueueByStaffIDEndsWith>String</AddedToQueueByStaffIDEndsWith>
<AddedToQueueByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AddedToQueueByStaffIDIn>
<AddedToQueueByStaffIDLike>String</AddedToQueueByStaffIDLike>
<AddedToQueueByStaffIDStartsWith>String</AddedToQueueByStaffIDStartsWith>
<AddedToQueueDateTime>0001-01-01T00:00:00</AddedToQueueDateTime>
<AddedToQueueDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</AddedToQueueDateTimeBetween>
<AddedToQueueDateTimeGreaterThan>0001-01-01T00:00:00</AddedToQueueDateTimeGreaterThan>
<AddedToQueueDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</AddedToQueueDateTimeGreaterThanOrEqualTo>
<AddedToQueueDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</AddedToQueueDateTimeIn>
<AddedToQueueDateTimeLessThan>0001-01-01T00:00:00</AddedToQueueDateTimeLessThan>
<AddedToQueueDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</AddedToQueueDateTimeLessThanOrEqualTo>
<AddedToQueueDateTimeNotEqualTo>0001-01-01T00:00:00</AddedToQueueDateTimeNotEqualTo>
<BatchNo>String</BatchNo>
<BatchNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</BatchNoBetween>
<BatchNoContains>String</BatchNoContains>
<BatchNoEndsWith>String</BatchNoEndsWith>
<BatchNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</BatchNoIn>
<BatchNoLike>String</BatchNoLike>
<BatchNoStartsWith>String</BatchNoStartsWith>
<ImportBatchID>String</ImportBatchID>
<ImportBatchIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImportBatchIDBetween>
<ImportBatchIDContains>String</ImportBatchIDContains>
<ImportBatchIDEndsWith>String</ImportBatchIDEndsWith>
<ImportBatchIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImportBatchIDIn>
<ImportBatchIDLike>String</ImportBatchIDLike>
<ImportBatchIDStartsWith>String</ImportBatchIDStartsWith>
<ImportErrorMessage>String</ImportErrorMessage>
<ImportErrorMessageBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImportErrorMessageBetween>
<ImportErrorMessageContains>String</ImportErrorMessageContains>
<ImportErrorMessageEndsWith>String</ImportErrorMessageEndsWith>
<ImportErrorMessageIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImportErrorMessageIn>
<ImportErrorMessageLike>String</ImportErrorMessageLike>
<ImportErrorMessageStartsWith>String</ImportErrorMessageStartsWith>
<ImportQueueID>String</ImportQueueID>
<ImportQueueIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImportQueueIDBetween>
<ImportQueueIDContains>String</ImportQueueIDContains>
<ImportQueueIDEndsWith>String</ImportQueueIDEndsWith>
<ImportQueueIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImportQueueIDIn>
<ImportQueueIDLike>String</ImportQueueIDLike>
<ImportQueueIDStartsWith>String</ImportQueueIDStartsWith>
<ImportSuccessMessage>String</ImportSuccessMessage>
<ImportSuccessMessageBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImportSuccessMessageBetween>
<ImportSuccessMessageContains>String</ImportSuccessMessageContains>
<ImportSuccessMessageEndsWith>String</ImportSuccessMessageEndsWith>
<ImportSuccessMessageIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImportSuccessMessageIn>
<ImportSuccessMessageLike>String</ImportSuccessMessageLike>
<ImportSuccessMessageStartsWith>String</ImportSuccessMessageStartsWith>
<ItemNo>0</ItemNo>
<ItemNoBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:int>0</d2p1:int>
</ItemNoBetween>
<ItemNoGreaterThan>0</ItemNoGreaterThan>
<ItemNoGreaterThanOrEqualTo>0</ItemNoGreaterThanOrEqualTo>
<ItemNoIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:int>0</d2p1:int>
</ItemNoIn>
<ItemNoLessThan>0</ItemNoLessThan>
<ItemNoLessThanOrEqualTo>0</ItemNoLessThanOrEqualTo>
<ItemNoNotEqualTo>0</ItemNoNotEqualTo>
<LastSavedByStaffID>String</LastSavedByStaffID>
<LastSavedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</LastSavedByStaffIDBetween>
<LastSavedByStaffIDContains>String</LastSavedByStaffIDContains>
<LastSavedByStaffIDEndsWith>String</LastSavedByStaffIDEndsWith>
<LastSavedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</LastSavedByStaffIDIn>
<LastSavedByStaffIDLike>String</LastSavedByStaffIDLike>
<LastSavedByStaffIDStartsWith>String</LastSavedByStaffIDStartsWith>
<LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
<LastSavedDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</LastSavedDateTimeBetween>
<LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
<LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
<LastSavedDateTimeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</LastSavedDateTimeIn>
<LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
<LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
<LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
<OriginalXML>String</OriginalXML>
<OriginalXMLBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OriginalXMLBetween>
<OriginalXMLContains>String</OriginalXMLContains>
<OriginalXMLEndsWith>String</OriginalXMLEndsWith>
<OriginalXMLIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OriginalXMLIn>
<OriginalXMLLike>String</OriginalXMLLike>
<OriginalXMLStartsWith>String</OriginalXMLStartsWith>
<Status>0</Status>
<StatusBetween>AA==</StatusBetween>
<StatusGreaterThan>0</StatusGreaterThan>
<StatusGreaterThanOrEqualTo>0</StatusGreaterThanOrEqualTo>
<StatusIn>AA==</StatusIn>
<StatusLessThan>0</StatusLessThan>
<StatusLessThanOrEqualTo>0</StatusLessThanOrEqualTo>
<StatusNotEqualTo>0</StatusNotEqualTo>
<TransformedXML>String</TransformedXML>
<TransformedXMLBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TransformedXMLBetween>
<TransformedXMLContains>String</TransformedXMLContains>
<TransformedXMLEndsWith>String</TransformedXMLEndsWith>
<TransformedXMLIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TransformedXMLIn>
<TransformedXMLLike>String</TransformedXMLLike>
<TransformedXMLStartsWith>String</TransformedXMLStartsWith>
</IM_ImportQueueQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfIM_ImportQueue7kRqkrSv 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:IM_ImportQueue> <d2p1:_x003C_AddedToQueueByStaffID_x003E_k__BackingField>String</d2p1:_x003C_AddedToQueueByStaffID_x003E_k__BackingField> <d2p1:_x003C_AddedToQueueDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_AddedToQueueDateTime_x003E_k__BackingField> <d2p1:_x003C_BatchNo_x003E_k__BackingField>String</d2p1:_x003C_BatchNo_x003E_k__BackingField> <d2p1:_x003C_ImportBatchID_x003E_k__BackingField>String</d2p1:_x003C_ImportBatchID_x003E_k__BackingField> <d2p1:_x003C_ImportErrorMessage_x003E_k__BackingField>String</d2p1:_x003C_ImportErrorMessage_x003E_k__BackingField> <d2p1:_x003C_ImportQueueID_x003E_k__BackingField>String</d2p1:_x003C_ImportQueueID_x003E_k__BackingField> <d2p1:_x003C_ImportSuccessMessage_x003E_k__BackingField>String</d2p1:_x003C_ImportSuccessMessage_x003E_k__BackingField> <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField> <d2p1:_x003C_LastSavedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_LastSavedByStaffID_x003E_k__BackingField> <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField> <d2p1:_x003C_OriginalXML_x003E_k__BackingField>String</d2p1:_x003C_OriginalXML_x003E_k__BackingField> <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField> <d2p1:_x003C_TransformedXML_x003E_k__BackingField>String</d2p1:_x003C_TransformedXML_x003E_k__BackingField> </d2p1:IM_ImportQueue> </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> </QueryResponseOfIM_ImportQueue7kRqkrSv>