Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | 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 | |
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 | DateTime[] | No | |
LastSavedDateTimeIn | query | 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 | |
CreatedDateTime | query | DateTime? | No | |
CreatedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
CreatedDateTimeGreaterThan | query | DateTime? | No | |
CreatedDateTimeLessThan | query | DateTime? | No | |
CreatedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
CreatedDateTimeNotEqualTo | query | DateTime? | No | |
CreatedDateTimeBetween | query | DateTime[] | No | |
CreatedDateTimeIn | query | DateTime[] | No | |
CreatedByStaffID | query | string | No | |
CreatedByStaffIDStartsWith | query | string | No | |
CreatedByStaffIDEndsWith | query | string | No | |
CreatedByStaffIDContains | query | string | No | |
CreatedByStaffIDLike | query | string | No | |
CreatedByStaffIDBetween | query | string[] | No | |
CreatedByStaffIDIn | query | string[] | No | |
ActivatedDateTime | query | DateTime? | No | |
ActivatedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
ActivatedDateTimeGreaterThan | query | DateTime? | No | |
ActivatedDateTimeLessThan | query | DateTime? | No | |
ActivatedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
ActivatedDateTimeNotEqualTo | query | DateTime? | No | |
ActivatedDateTimeBetween | query | Nullable<DateTime>[] | No | |
ActivatedDateTimeIn | query | Nullable<DateTime>[] | No | |
ActivatedByStaffID | query | string | No | |
ActivatedByStaffIDStartsWith | query | string | No | |
ActivatedByStaffIDEndsWith | query | string | No | |
ActivatedByStaffIDContains | query | string | No | |
ActivatedByStaffIDLike | query | string | No | |
ActivatedByStaffIDBetween | query | string[] | No | |
ActivatedByStaffIDIn | query | string[] | No | |
IN_LogicalID | query | string | No | |
IN_LogicalIDStartsWith | query | string | No | |
IN_LogicalIDEndsWith | query | string | No | |
IN_LogicalIDContains | query | string | No | |
IN_LogicalIDLike | query | string | No | |
IN_LogicalIDBetween | query | string[] | No | |
IN_LogicalIDIn | query | string[] | No | |
Status | query | short? | No | |
StatusGreaterThanOrEqualTo | query | short? | No | |
StatusGreaterThan | query | short? | No | |
StatusLessThan | query | short? | No | |
StatusLessThanOrEqualTo | query | short? | No | |
StatusNotEqualTo | query | short? | No | |
StatusBetween | query | short[] | No | |
StatusIn | query | short[] | No | |
Notes | query | string | No | |
NotesStartsWith | query | string | No | |
NotesEndsWith | query | string | No | |
NotesContains | query | string | No | |
NotesLike | query | string | No | |
NotesBetween | query | string[] | No | |
NotesIn | query | string[] | No | |
BORunNo | query | string | No | |
BORunNoStartsWith | query | string | No | |
BORunNoEndsWith | query | string | No | |
BORunNoContains | query | string | No | |
BORunNoLike | query | string | No | |
BORunNoBetween | query | string[] | No | |
BORunNoIn | 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 |
---|---|---|---|---|
RecID | form | string | No | |
BatchNo | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
LastSavedByStaffID | form | string | No | |
CreatedDateTime | form | DateTime | No | |
CreatedByStaffID | form | string | No | |
ActivatedDateTime | form | DateTime? | No | |
ActivatedByStaffID | form | string | No | |
IN_LogicalID | form | string | No | |
Status | form | short | No | |
Notes | form | string | No | |
BORunNo | 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/BO_ManualReleaseBatchQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BO_ManualReleaseBatchQuery 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>
<ActivatedByStaffID>String</ActivatedByStaffID>
<ActivatedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ActivatedByStaffIDBetween>
<ActivatedByStaffIDContains>String</ActivatedByStaffIDContains>
<ActivatedByStaffIDEndsWith>String</ActivatedByStaffIDEndsWith>
<ActivatedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ActivatedByStaffIDIn>
<ActivatedByStaffIDLike>String</ActivatedByStaffIDLike>
<ActivatedByStaffIDStartsWith>String</ActivatedByStaffIDStartsWith>
<ActivatedDateTime>0001-01-01T00:00:00</ActivatedDateTime>
<ActivatedDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</ActivatedDateTimeBetween>
<ActivatedDateTimeGreaterThan>0001-01-01T00:00:00</ActivatedDateTimeGreaterThan>
<ActivatedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</ActivatedDateTimeGreaterThanOrEqualTo>
<ActivatedDateTimeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</ActivatedDateTimeIn>
<ActivatedDateTimeLessThan>0001-01-01T00:00:00</ActivatedDateTimeLessThan>
<ActivatedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</ActivatedDateTimeLessThanOrEqualTo>
<ActivatedDateTimeNotEqualTo>0001-01-01T00:00:00</ActivatedDateTimeNotEqualTo>
<BORunNo>String</BORunNo>
<BORunNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</BORunNoBetween>
<BORunNoContains>String</BORunNoContains>
<BORunNoEndsWith>String</BORunNoEndsWith>
<BORunNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</BORunNoIn>
<BORunNoLike>String</BORunNoLike>
<BORunNoStartsWith>String</BORunNoStartsWith>
<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>
<CreatedByStaffID>String</CreatedByStaffID>
<CreatedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</CreatedByStaffIDBetween>
<CreatedByStaffIDContains>String</CreatedByStaffIDContains>
<CreatedByStaffIDEndsWith>String</CreatedByStaffIDEndsWith>
<CreatedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</CreatedByStaffIDIn>
<CreatedByStaffIDLike>String</CreatedByStaffIDLike>
<CreatedByStaffIDStartsWith>String</CreatedByStaffIDStartsWith>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<CreatedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</CreatedDateTimeBetween>
<CreatedDateTimeGreaterThan>0001-01-01T00:00:00</CreatedDateTimeGreaterThan>
<CreatedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</CreatedDateTimeGreaterThanOrEqualTo>
<CreatedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</CreatedDateTimeIn>
<CreatedDateTimeLessThan>0001-01-01T00:00:00</CreatedDateTimeLessThan>
<CreatedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</CreatedDateTimeLessThanOrEqualTo>
<CreatedDateTimeNotEqualTo>0001-01-01T00:00:00</CreatedDateTimeNotEqualTo>
<IN_LogicalID>String</IN_LogicalID>
<IN_LogicalIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IN_LogicalIDBetween>
<IN_LogicalIDContains>String</IN_LogicalIDContains>
<IN_LogicalIDEndsWith>String</IN_LogicalIDEndsWith>
<IN_LogicalIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IN_LogicalIDIn>
<IN_LogicalIDLike>String</IN_LogicalIDLike>
<IN_LogicalIDStartsWith>String</IN_LogicalIDStartsWith>
<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.microsoft.com/2003/10/Serialization/Arrays">
<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.microsoft.com/2003/10/Serialization/Arrays">
<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>
<Notes>String</Notes>
<NotesBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NotesBetween>
<NotesContains>String</NotesContains>
<NotesEndsWith>String</NotesEndsWith>
<NotesIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NotesIn>
<NotesLike>String</NotesLike>
<NotesStartsWith>String</NotesStartsWith>
<RecID>String</RecID>
<RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RecIDBetween>
<RecIDContains>String</RecIDContains>
<RecIDEndsWith>String</RecIDEndsWith>
<RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RecIDIn>
<RecIDLike>String</RecIDLike>
<RecIDStartsWith>String</RecIDStartsWith>
<Status>0</Status>
<StatusBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</StatusBetween>
<StatusGreaterThan>0</StatusGreaterThan>
<StatusGreaterThanOrEqualTo>0</StatusGreaterThanOrEqualTo>
<StatusIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</StatusIn>
<StatusLessThan>0</StatusLessThan>
<StatusLessThanOrEqualTo>0</StatusLessThanOrEqualTo>
<StatusNotEqualTo>0</StatusNotEqualTo>
</BO_ManualReleaseBatchQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfBO_ManualReleaseBatch7kRqkrSv 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:BO_ManualReleaseBatch> <d2p1:_x003C_ActivatedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_ActivatedByStaffID_x003E_k__BackingField> <d2p1:_x003C_ActivatedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ActivatedDateTime_x003E_k__BackingField> <d2p1:_x003C_BORunNo_x003E_k__BackingField>String</d2p1:_x003C_BORunNo_x003E_k__BackingField> <d2p1:_x003C_BatchNo_x003E_k__BackingField>String</d2p1:_x003C_BatchNo_x003E_k__BackingField> <d2p1:_x003C_CreatedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_CreatedByStaffID_x003E_k__BackingField> <d2p1:_x003C_CreatedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_CreatedDateTime_x003E_k__BackingField> <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_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_Notes_x003E_k__BackingField>String</d2p1:_x003C_Notes_x003E_k__BackingField> <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField> <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField> </d2p1:BO_ManualReleaseBatch> </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> </QueryResponseOfBO_ManualReleaseBatch7kRqkrSv>