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 | |
Name | query | string | No | |
NameStartsWith | query | string | No | |
NameEndsWith | query | string | No | |
NameContains | query | string | No | |
NameLike | query | string | No | |
NameBetween | query | string[] | No | |
NameIn | query | string[] | No | |
WriteOffAccountOverride | query | bool? | No | |
WriteOffAccountID | query | string | No | |
WriteOffAccountIDStartsWith | query | string | No | |
WriteOffAccountIDEndsWith | query | string | No | |
WriteOffAccountIDContains | query | string | No | |
WriteOffAccountIDLike | query | string | No | |
WriteOffAccountIDBetween | query | string[] | No | |
WriteOffAccountIDIn | query | string[] | No | |
WriteOnAccountOverride | query | bool? | No | |
WriteOnAccountID | query | string | No | |
WriteOnAccountIDStartsWith | query | string | No | |
WriteOnAccountIDEndsWith | query | string | No | |
WriteOnAccountIDContains | query | string | No | |
WriteOnAccountIDLike | query | string | No | |
WriteOnAccountIDBetween | query | string[] | No | |
WriteOnAccountIDIn | query | string[] | No | |
DefaultReason | query | bool? | No | |
ReadOnly | query | bool? | 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 | Nullable<DateTime>[] | No | |
CreatedDateTimeIn | query | Nullable<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 | |
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 | |
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 | |
RowHash | query | byte[] | 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 | |
Name | form | string | No | |
WriteOffAccountOverride | form | bool? | No | |
WriteOffAccountID | form | string | No | |
WriteOnAccountOverride | form | bool? | No | |
WriteOnAccountID | form | string | No | |
DefaultReason | form | bool? | No | |
ReadOnly | form | bool? | No | |
CreatedDateTime | form | DateTime? | No | |
CreatedByStaffID | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
LastSavedByStaffID | form | string | No | |
ItemNo | form | int? | No | |
RowHash | form | byte[] | 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/IN_TransferReasonsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<IN_TransferReasonsQuery 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>
<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.datacontract.org/2004/07/System">
<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.datacontract.org/2004/07/System">
<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>
<DefaultReason>false</DefaultReason>
<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>
<Name>String</Name>
<NameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NameBetween>
<NameContains>String</NameContains>
<NameEndsWith>String</NameEndsWith>
<NameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NameIn>
<NameLike>String</NameLike>
<NameStartsWith>String</NameStartsWith>
<ReadOnly>false</ReadOnly>
<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>
<RowHash>AA==</RowHash>
<WriteOffAccountID>String</WriteOffAccountID>
<WriteOffAccountIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</WriteOffAccountIDBetween>
<WriteOffAccountIDContains>String</WriteOffAccountIDContains>
<WriteOffAccountIDEndsWith>String</WriteOffAccountIDEndsWith>
<WriteOffAccountIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</WriteOffAccountIDIn>
<WriteOffAccountIDLike>String</WriteOffAccountIDLike>
<WriteOffAccountIDStartsWith>String</WriteOffAccountIDStartsWith>
<WriteOffAccountOverride>false</WriteOffAccountOverride>
<WriteOnAccountID>String</WriteOnAccountID>
<WriteOnAccountIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</WriteOnAccountIDBetween>
<WriteOnAccountIDContains>String</WriteOnAccountIDContains>
<WriteOnAccountIDEndsWith>String</WriteOnAccountIDEndsWith>
<WriteOnAccountIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</WriteOnAccountIDIn>
<WriteOnAccountIDLike>String</WriteOnAccountIDLike>
<WriteOnAccountIDStartsWith>String</WriteOnAccountIDStartsWith>
<WriteOnAccountOverride>false</WriteOnAccountOverride>
</IN_TransferReasonsQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfIN_TransferReasons7kRqkrSv 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:IN_TransferReasons> <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_DefaultReason_x003E_k__BackingField>false</d2p1:_x003C_DefaultReason_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_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField> <d2p1:_x003C_ReadOnly_x003E_k__BackingField>false</d2p1:_x003C_ReadOnly_x003E_k__BackingField> <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField> <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField> <d2p1:_x003C_WriteOffAccountID_x003E_k__BackingField>String</d2p1:_x003C_WriteOffAccountID_x003E_k__BackingField> <d2p1:_x003C_WriteOffAccountOverride_x003E_k__BackingField>false</d2p1:_x003C_WriteOffAccountOverride_x003E_k__BackingField> <d2p1:_x003C_WriteOnAccountID_x003E_k__BackingField>String</d2p1:_x003C_WriteOnAccountID_x003E_k__BackingField> <d2p1:_x003C_WriteOnAccountOverride_x003E_k__BackingField>false</d2p1:_x003C_WriteOnAccountOverride_x003E_k__BackingField> </d2p1:IN_TransferReasons> </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> </QueryResponseOfIN_TransferReasons7kRqkrSv>