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 | |
AR_Main_RecID | query | string | No | |
AR_Main_RecIDStartsWith | query | string | No | |
AR_Main_RecIDEndsWith | query | string | No | |
AR_Main_RecIDContains | query | string | No | |
AR_Main_RecIDLike | query | string | No | |
AR_Main_RecIDBetween | query | string[] | No | |
AR_Main_RecIDIn | 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 | Nullable<Byte>[] | No | |
StatusIn | query | Nullable<Byte>[] | No | |
StartDateTime | query | DateTime? | No | |
StartDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
StartDateTimeGreaterThan | query | DateTime? | No | |
StartDateTimeLessThan | query | DateTime? | No | |
StartDateTimeLessThanOrEqualTo | query | DateTime? | No | |
StartDateTimeNotEqualTo | query | DateTime? | No | |
StartDateTimeBetween | query | DateTime[] | No | |
StartDateTimeIn | query | DateTime[] | No | |
EndDateTime | query | DateTime? | No | |
EndDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
EndDateTimeGreaterThan | query | DateTime? | No | |
EndDateTimeLessThan | query | DateTime? | No | |
EndDateTimeLessThanOrEqualTo | query | DateTime? | No | |
EndDateTimeNotEqualTo | query | DateTime? | No | |
EndDateTimeBetween | query | DateTime[] | No | |
EndDateTimeIn | query | DateTime[] | No | |
Message | query | string | No | |
MessageStartsWith | query | string | No | |
MessageEndsWith | query | string | No | |
MessageContains | query | string | No | |
MessageLike | query | string | No | |
MessageBetween | query | string[] | No | |
MessageIn | query | string[] | No | |
Report | query | string | No | |
ReportStartsWith | query | string | No | |
ReportEndsWith | query | string | No | |
ReportContains | query | string | No | |
ReportLike | query | string | No | |
ReportBetween | query | string[] | No | |
ReportIn | 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 | |
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 | |
ExecutionID | query | string | No | |
ExecutionIDStartsWith | query | string | No | |
ExecutionIDEndsWith | query | string | No | |
ExecutionIDContains | query | string | No | |
ExecutionIDLike | query | string | No | |
ExecutionIDBetween | query | string[] | No | |
ExecutionIDIn | 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 | |
AR_Main_RecID | form | string | No | |
Status | form | byte? | No | |
StartDateTime | form | DateTime | No | |
EndDateTime | form | DateTime | No | |
Message | form | string | No | |
Report | form | string | No | |
CreatedDateTime | form | DateTime | No | |
CreatedByStaffID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
LastSavedByStaffID | form | string | No | |
ExecutionID | 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/AR_HistoryQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AR_HistoryQuery 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>
<AR_Main_RecID>String</AR_Main_RecID>
<AR_Main_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AR_Main_RecIDBetween>
<AR_Main_RecIDContains>String</AR_Main_RecIDContains>
<AR_Main_RecIDEndsWith>String</AR_Main_RecIDEndsWith>
<AR_Main_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AR_Main_RecIDIn>
<AR_Main_RecIDLike>String</AR_Main_RecIDLike>
<AR_Main_RecIDStartsWith>String</AR_Main_RecIDStartsWith>
<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>
<EndDateTime>0001-01-01T00:00:00</EndDateTime>
<EndDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</EndDateTimeBetween>
<EndDateTimeGreaterThan>0001-01-01T00:00:00</EndDateTimeGreaterThan>
<EndDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</EndDateTimeGreaterThanOrEqualTo>
<EndDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</EndDateTimeIn>
<EndDateTimeLessThan>0001-01-01T00:00:00</EndDateTimeLessThan>
<EndDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</EndDateTimeLessThanOrEqualTo>
<EndDateTimeNotEqualTo>0001-01-01T00:00:00</EndDateTimeNotEqualTo>
<ExecutionID>String</ExecutionID>
<ExecutionIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ExecutionIDBetween>
<ExecutionIDContains>String</ExecutionIDContains>
<ExecutionIDEndsWith>String</ExecutionIDEndsWith>
<ExecutionIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ExecutionIDIn>
<ExecutionIDLike>String</ExecutionIDLike>
<ExecutionIDStartsWith>String</ExecutionIDStartsWith>
<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>
<Message>String</Message>
<MessageBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</MessageBetween>
<MessageContains>String</MessageContains>
<MessageEndsWith>String</MessageEndsWith>
<MessageIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</MessageIn>
<MessageLike>String</MessageLike>
<MessageStartsWith>String</MessageStartsWith>
<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>
<Report>String</Report>
<ReportBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ReportBetween>
<ReportContains>String</ReportContains>
<ReportEndsWith>String</ReportEndsWith>
<ReportIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ReportIn>
<ReportLike>String</ReportLike>
<ReportStartsWith>String</ReportStartsWith>
<StartDateTime>0001-01-01T00:00:00</StartDateTime>
<StartDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</StartDateTimeBetween>
<StartDateTimeGreaterThan>0001-01-01T00:00:00</StartDateTimeGreaterThan>
<StartDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</StartDateTimeGreaterThanOrEqualTo>
<StartDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</StartDateTimeIn>
<StartDateTimeLessThan>0001-01-01T00:00:00</StartDateTimeLessThan>
<StartDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</StartDateTimeLessThanOrEqualTo>
<StartDateTimeNotEqualTo>0001-01-01T00:00:00</StartDateTimeNotEqualTo>
<Status>0</Status>
<StatusBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:unsignedByte>0</d2p1:unsignedByte>
</StatusBetween>
<StatusGreaterThan>0</StatusGreaterThan>
<StatusGreaterThanOrEqualTo>0</StatusGreaterThanOrEqualTo>
<StatusIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:unsignedByte>0</d2p1:unsignedByte>
</StatusIn>
<StatusLessThan>0</StatusLessThan>
<StatusLessThanOrEqualTo>0</StatusLessThanOrEqualTo>
<StatusNotEqualTo>0</StatusNotEqualTo>
</AR_HistoryQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfAR_History7kRqkrSv 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:AR_History> <d2p1:_x003C_AR_Main_RecID_x003E_k__BackingField>String</d2p1:_x003C_AR_Main_RecID_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_EndDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_EndDateTime_x003E_k__BackingField> <d2p1:_x003C_ExecutionID_x003E_k__BackingField>String</d2p1:_x003C_ExecutionID_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_Message_x003E_k__BackingField>String</d2p1:_x003C_Message_x003E_k__BackingField> <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField> <d2p1:_x003C_Report_x003E_k__BackingField>String</d2p1:_x003C_Report_x003E_k__BackingField> <d2p1:_x003C_StartDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_StartDateTime_x003E_k__BackingField> <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField> </d2p1:AR_History> </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> </QueryResponseOfAR_History7kRqkrSv>