Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReceiptID | query | string | No | |
ReceiptIDStartsWith | query | string | No | |
ReceiptIDEndsWith | query | string | No | |
ReceiptIDContains | query | string | No | |
ReceiptIDLike | query | string | No | |
ReceiptIDBetween | query | string[] | No | |
ReceiptIDIn | 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 | |
JiwaUser | query | string | No | |
JiwaUserStartsWith | query | string | No | |
JiwaUserEndsWith | query | string | No | |
JiwaUserContains | query | string | No | |
JiwaUserLike | query | string | No | |
JiwaUserBetween | query | string[] | No | |
JiwaUserIn | query | string[] | No | |
ReceiptDate | query | DateTime? | No | |
ReceiptDateGreaterThanOrEqualTo | query | DateTime? | No | |
ReceiptDateGreaterThan | query | DateTime? | No | |
ReceiptDateLessThan | query | DateTime? | No | |
ReceiptDateLessThanOrEqualTo | query | DateTime? | No | |
ReceiptDateNotEqualTo | query | DateTime? | No | |
ReceiptDateBetween | query | Nullable<DateTime>[] | No | |
ReceiptDateIn | query | Nullable<DateTime>[] | No | |
BatchNum | query | string | No | |
BatchNumStartsWith | query | string | No | |
BatchNumEndsWith | query | string | No | |
BatchNumContains | query | string | No | |
BatchNumLike | query | string | No | |
BatchNumBetween | query | string[] | No | |
BatchNumIn | query | string[] | No | |
ReceiptType | query | short? | No | |
ReceiptTypeGreaterThanOrEqualTo | query | short? | No | |
ReceiptTypeGreaterThan | query | short? | No | |
ReceiptTypeLessThan | query | short? | No | |
ReceiptTypeLessThanOrEqualTo | query | short? | No | |
ReceiptTypeNotEqualTo | query | short? | No | |
ReceiptTypeBetween | query | Nullable<Int16>[] | No | |
ReceiptTypeIn | query | Nullable<Int16>[] | No | |
ReceiptStatus | query | short? | No | |
ReceiptStatusGreaterThanOrEqualTo | query | short? | No | |
ReceiptStatusGreaterThan | query | short? | No | |
ReceiptStatusLessThan | query | short? | No | |
ReceiptStatusLessThanOrEqualTo | query | short? | No | |
ReceiptStatusNotEqualTo | query | short? | No | |
ReceiptStatusBetween | query | Nullable<Int16>[] | No | |
ReceiptStatusIn | query | Nullable<Int16>[] | No | |
BatchType | query | short? | No | |
BatchTypeGreaterThanOrEqualTo | query | short? | No | |
BatchTypeGreaterThan | query | short? | No | |
BatchTypeLessThan | query | short? | No | |
BatchTypeLessThanOrEqualTo | query | short? | No | |
BatchTypeNotEqualTo | query | short? | No | |
BatchTypeBetween | query | short[] | No | |
BatchTypeIn | query | short[] | No | |
RepeatingType | query | short? | No | |
RepeatingTypeGreaterThanOrEqualTo | query | short? | No | |
RepeatingTypeGreaterThan | query | short? | No | |
RepeatingTypeLessThan | query | short? | No | |
RepeatingTypeLessThanOrEqualTo | query | short? | No | |
RepeatingTypeNotEqualTo | query | short? | No | |
RepeatingTypeBetween | query | short[] | No | |
RepeatingTypeIn | query | short[] | No | |
RepeatingUnits | query | short? | No | |
RepeatingUnitsGreaterThanOrEqualTo | query | short? | No | |
RepeatingUnitsGreaterThan | query | short? | No | |
RepeatingUnitsLessThan | query | short? | No | |
RepeatingUnitsLessThanOrEqualTo | query | short? | No | |
RepeatingUnitsNotEqualTo | query | short? | No | |
RepeatingUnitsBetween | query | short[] | No | |
RepeatingUnitsIn | query | short[] | No | |
NextRepeatingDate | query | DateTime? | No | |
NextRepeatingDateGreaterThanOrEqualTo | query | DateTime? | No | |
NextRepeatingDateGreaterThan | query | DateTime? | No | |
NextRepeatingDateLessThan | query | DateTime? | No | |
NextRepeatingDateLessThanOrEqualTo | query | DateTime? | No | |
NextRepeatingDateNotEqualTo | query | DateTime? | No | |
NextRepeatingDateBetween | query | Nullable<DateTime>[] | No | |
NextRepeatingDateIn | query | Nullable<DateTime>[] | No | |
RepeatingWillEnd | query | bool? | No | |
RepeatingEndDate | query | DateTime? | No | |
RepeatingEndDateGreaterThanOrEqualTo | query | DateTime? | No | |
RepeatingEndDateGreaterThan | query | DateTime? | No | |
RepeatingEndDateLessThan | query | DateTime? | No | |
RepeatingEndDateLessThanOrEqualTo | query | DateTime? | No | |
RepeatingEndDateNotEqualTo | query | DateTime? | No | |
RepeatingEndDateBetween | query | Nullable<DateTime>[] | No | |
RepeatingEndDateIn | query | Nullable<DateTime>[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | 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 |
---|---|---|---|---|
ReceiptID | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
JiwaUser | form | string | No | |
ReceiptDate | form | DateTime? | No | |
BatchNum | form | string | No | |
ReceiptType | form | short? | No | |
ReceiptStatus | form | short? | No | |
BatchType | form | short | No | |
RepeatingType | form | short | No | |
RepeatingUnits | form | short | No | |
NextRepeatingDate | form | DateTime? | No | |
RepeatingWillEnd | form | bool | No | |
RepeatingEndDate | form | DateTime? | No | |
Description | 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/CR_BatchTransQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CR_BatchTransQuery 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>
<BatchNum>String</BatchNum>
<BatchNumBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</BatchNumBetween>
<BatchNumContains>String</BatchNumContains>
<BatchNumEndsWith>String</BatchNumEndsWith>
<BatchNumIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</BatchNumIn>
<BatchNumLike>String</BatchNumLike>
<BatchNumStartsWith>String</BatchNumStartsWith>
<BatchType>0</BatchType>
<BatchTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</BatchTypeBetween>
<BatchTypeGreaterThan>0</BatchTypeGreaterThan>
<BatchTypeGreaterThanOrEqualTo>0</BatchTypeGreaterThanOrEqualTo>
<BatchTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</BatchTypeIn>
<BatchTypeLessThan>0</BatchTypeLessThan>
<BatchTypeLessThanOrEqualTo>0</BatchTypeLessThanOrEqualTo>
<BatchTypeNotEqualTo>0</BatchTypeNotEqualTo>
<Description>String</Description>
<DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DescriptionBetween>
<DescriptionContains>String</DescriptionContains>
<DescriptionEndsWith>String</DescriptionEndsWith>
<DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DescriptionIn>
<DescriptionLike>String</DescriptionLike>
<DescriptionStartsWith>String</DescriptionStartsWith>
<JiwaUser>String</JiwaUser>
<JiwaUserBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</JiwaUserBetween>
<JiwaUserContains>String</JiwaUserContains>
<JiwaUserEndsWith>String</JiwaUserEndsWith>
<JiwaUserIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</JiwaUserIn>
<JiwaUserLike>String</JiwaUserLike>
<JiwaUserStartsWith>String</JiwaUserStartsWith>
<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>
<NextRepeatingDate>0001-01-01T00:00:00</NextRepeatingDate>
<NextRepeatingDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</NextRepeatingDateBetween>
<NextRepeatingDateGreaterThan>0001-01-01T00:00:00</NextRepeatingDateGreaterThan>
<NextRepeatingDateGreaterThanOrEqualTo>0001-01-01T00:00:00</NextRepeatingDateGreaterThanOrEqualTo>
<NextRepeatingDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</NextRepeatingDateIn>
<NextRepeatingDateLessThan>0001-01-01T00:00:00</NextRepeatingDateLessThan>
<NextRepeatingDateLessThanOrEqualTo>0001-01-01T00:00:00</NextRepeatingDateLessThanOrEqualTo>
<NextRepeatingDateNotEqualTo>0001-01-01T00:00:00</NextRepeatingDateNotEqualTo>
<ReceiptDate>0001-01-01T00:00:00</ReceiptDate>
<ReceiptDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</ReceiptDateBetween>
<ReceiptDateGreaterThan>0001-01-01T00:00:00</ReceiptDateGreaterThan>
<ReceiptDateGreaterThanOrEqualTo>0001-01-01T00:00:00</ReceiptDateGreaterThanOrEqualTo>
<ReceiptDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</ReceiptDateIn>
<ReceiptDateLessThan>0001-01-01T00:00:00</ReceiptDateLessThan>
<ReceiptDateLessThanOrEqualTo>0001-01-01T00:00:00</ReceiptDateLessThanOrEqualTo>
<ReceiptDateNotEqualTo>0001-01-01T00:00:00</ReceiptDateNotEqualTo>
<ReceiptID>String</ReceiptID>
<ReceiptIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ReceiptIDBetween>
<ReceiptIDContains>String</ReceiptIDContains>
<ReceiptIDEndsWith>String</ReceiptIDEndsWith>
<ReceiptIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ReceiptIDIn>
<ReceiptIDLike>String</ReceiptIDLike>
<ReceiptIDStartsWith>String</ReceiptIDStartsWith>
<ReceiptStatus>0</ReceiptStatus>
<ReceiptStatusBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:short>0</d2p1:short>
</ReceiptStatusBetween>
<ReceiptStatusGreaterThan>0</ReceiptStatusGreaterThan>
<ReceiptStatusGreaterThanOrEqualTo>0</ReceiptStatusGreaterThanOrEqualTo>
<ReceiptStatusIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:short>0</d2p1:short>
</ReceiptStatusIn>
<ReceiptStatusLessThan>0</ReceiptStatusLessThan>
<ReceiptStatusLessThanOrEqualTo>0</ReceiptStatusLessThanOrEqualTo>
<ReceiptStatusNotEqualTo>0</ReceiptStatusNotEqualTo>
<ReceiptType>0</ReceiptType>
<ReceiptTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:short>0</d2p1:short>
</ReceiptTypeBetween>
<ReceiptTypeGreaterThan>0</ReceiptTypeGreaterThan>
<ReceiptTypeGreaterThanOrEqualTo>0</ReceiptTypeGreaterThanOrEqualTo>
<ReceiptTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:short>0</d2p1:short>
</ReceiptTypeIn>
<ReceiptTypeLessThan>0</ReceiptTypeLessThan>
<ReceiptTypeLessThanOrEqualTo>0</ReceiptTypeLessThanOrEqualTo>
<ReceiptTypeNotEqualTo>0</ReceiptTypeNotEqualTo>
<RepeatingEndDate>0001-01-01T00:00:00</RepeatingEndDate>
<RepeatingEndDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</RepeatingEndDateBetween>
<RepeatingEndDateGreaterThan>0001-01-01T00:00:00</RepeatingEndDateGreaterThan>
<RepeatingEndDateGreaterThanOrEqualTo>0001-01-01T00:00:00</RepeatingEndDateGreaterThanOrEqualTo>
<RepeatingEndDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</RepeatingEndDateIn>
<RepeatingEndDateLessThan>0001-01-01T00:00:00</RepeatingEndDateLessThan>
<RepeatingEndDateLessThanOrEqualTo>0001-01-01T00:00:00</RepeatingEndDateLessThanOrEqualTo>
<RepeatingEndDateNotEqualTo>0001-01-01T00:00:00</RepeatingEndDateNotEqualTo>
<RepeatingType>0</RepeatingType>
<RepeatingTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</RepeatingTypeBetween>
<RepeatingTypeGreaterThan>0</RepeatingTypeGreaterThan>
<RepeatingTypeGreaterThanOrEqualTo>0</RepeatingTypeGreaterThanOrEqualTo>
<RepeatingTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</RepeatingTypeIn>
<RepeatingTypeLessThan>0</RepeatingTypeLessThan>
<RepeatingTypeLessThanOrEqualTo>0</RepeatingTypeLessThanOrEqualTo>
<RepeatingTypeNotEqualTo>0</RepeatingTypeNotEqualTo>
<RepeatingUnits>0</RepeatingUnits>
<RepeatingUnitsBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</RepeatingUnitsBetween>
<RepeatingUnitsGreaterThan>0</RepeatingUnitsGreaterThan>
<RepeatingUnitsGreaterThanOrEqualTo>0</RepeatingUnitsGreaterThanOrEqualTo>
<RepeatingUnitsIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</RepeatingUnitsIn>
<RepeatingUnitsLessThan>0</RepeatingUnitsLessThan>
<RepeatingUnitsLessThanOrEqualTo>0</RepeatingUnitsLessThanOrEqualTo>
<RepeatingUnitsNotEqualTo>0</RepeatingUnitsNotEqualTo>
<RepeatingWillEnd>false</RepeatingWillEnd>
</CR_BatchTransQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfCR_BatchTrans7kRqkrSv 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:CR_BatchTrans> <d2p1:_x003C_BatchNum_x003E_k__BackingField>String</d2p1:_x003C_BatchNum_x003E_k__BackingField> <d2p1:_x003C_BatchType_x003E_k__BackingField>0</d2p1:_x003C_BatchType_x003E_k__BackingField> <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField> <d2p1:_x003C_JiwaUser_x003E_k__BackingField>String</d2p1:_x003C_JiwaUser_x003E_k__BackingField> <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField> <d2p1:_x003C_NextRepeatingDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_NextRepeatingDate_x003E_k__BackingField> <d2p1:_x003C_ReceiptDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ReceiptDate_x003E_k__BackingField> <d2p1:_x003C_ReceiptID_x003E_k__BackingField>String</d2p1:_x003C_ReceiptID_x003E_k__BackingField> <d2p1:_x003C_ReceiptStatus_x003E_k__BackingField>0</d2p1:_x003C_ReceiptStatus_x003E_k__BackingField> <d2p1:_x003C_ReceiptType_x003E_k__BackingField>0</d2p1:_x003C_ReceiptType_x003E_k__BackingField> <d2p1:_x003C_RepeatingEndDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_RepeatingEndDate_x003E_k__BackingField> <d2p1:_x003C_RepeatingType_x003E_k__BackingField>0</d2p1:_x003C_RepeatingType_x003E_k__BackingField> <d2p1:_x003C_RepeatingUnits_x003E_k__BackingField>0</d2p1:_x003C_RepeatingUnits_x003E_k__BackingField> <d2p1:_x003C_RepeatingWillEnd_x003E_k__BackingField>false</d2p1:_x003C_RepeatingWillEnd_x003E_k__BackingField> </d2p1:CR_BatchTrans> </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> </QueryResponseOfCR_BatchTrans7kRqkrSv>