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 | |
IncidentNo | query | string | No | |
IncidentNoStartsWith | query | string | No | |
IncidentNoEndsWith | query | string | No | |
IncidentNoContains | query | string | No | |
IncidentNoLike | query | string | No | |
IncidentNoBetween | query | string[] | No | |
IncidentNoIn | query | string[] | No | |
DebtorID | query | string | No | |
DebtorIDStartsWith | query | string | No | |
DebtorIDEndsWith | query | string | No | |
DebtorIDContains | query | string | No | |
DebtorIDLike | query | string | No | |
DebtorIDBetween | query | string[] | No | |
DebtorIDIn | query | string[] | No | |
ContactName | query | string | No | |
ContactNameStartsWith | query | string | No | |
ContactNameEndsWith | query | string | No | |
ContactNameContains | query | string | No | |
ContactNameLike | query | string | No | |
ContactNameBetween | query | string[] | No | |
ContactNameIn | query | string[] | No | |
InvoiceID | query | string | No | |
InvoiceIDStartsWith | query | string | No | |
InvoiceIDEndsWith | query | string | No | |
InvoiceIDContains | query | string | No | |
InvoiceIDLike | query | string | No | |
InvoiceIDBetween | query | string[] | No | |
InvoiceIDIn | query | string[] | No | |
InvoiceHistoryID | query | string | No | |
InvoiceHistoryIDStartsWith | query | string | No | |
InvoiceHistoryIDEndsWith | query | string | No | |
InvoiceHistoryIDContains | query | string | No | |
InvoiceHistoryIDLike | query | string | No | |
InvoiceHistoryIDBetween | query | string[] | No | |
InvoiceHistoryIDIn | query | string[] | No | |
InvoiceLineID | query | string | No | |
InvoiceLineIDStartsWith | query | string | No | |
InvoiceLineIDEndsWith | query | string | No | |
InvoiceLineIDContains | query | string | No | |
InvoiceLineIDLike | query | string | No | |
InvoiceLineIDBetween | query | string[] | No | |
InvoiceLineIDIn | query | string[] | No | |
SO_IncidentTypes_RecID | query | string | No | |
SO_IncidentTypes_RecIDStartsWith | query | string | No | |
SO_IncidentTypes_RecIDEndsWith | query | string | No | |
SO_IncidentTypes_RecIDContains | query | string | No | |
SO_IncidentTypes_RecIDLike | query | string | No | |
SO_IncidentTypes_RecIDBetween | query | string[] | No | |
SO_IncidentTypes_RecIDIn | query | string[] | No | |
Details | query | string | No | |
DetailsStartsWith | query | string | No | |
DetailsEndsWith | query | string | No | |
DetailsContains | query | string | No | |
DetailsLike | query | string | No | |
DetailsBetween | query | string[] | No | |
DetailsIn | 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 | |
IncidentDate | query | DateTime? | No | |
IncidentDateGreaterThanOrEqualTo | query | DateTime? | No | |
IncidentDateGreaterThan | query | DateTime? | No | |
IncidentDateLessThan | query | DateTime? | No | |
IncidentDateLessThanOrEqualTo | query | DateTime? | No | |
IncidentDateNotEqualTo | query | DateTime? | No | |
IncidentDateBetween | query | Nullable<DateTime>[] | No | |
IncidentDateIn | query | Nullable<DateTime>[] | 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 | |
IncidentNo | form | string | No | |
DebtorID | form | string | No | |
ContactName | form | string | No | |
InvoiceID | form | string | No | |
InvoiceHistoryID | form | string | No | |
InvoiceLineID | form | string | No | |
SO_IncidentTypes_RecID | form | string | No | |
Details | form | string | No | |
CreatedDateTime | form | DateTime | No | |
CreatedByStaffID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
LastSavedByStaffID | form | string | No | |
IncidentDate | form | DateTime? | 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/SO_IncidentsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SO_IncidentsQuery 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>
<ContactName>String</ContactName>
<ContactNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ContactNameBetween>
<ContactNameContains>String</ContactNameContains>
<ContactNameEndsWith>String</ContactNameEndsWith>
<ContactNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ContactNameIn>
<ContactNameLike>String</ContactNameLike>
<ContactNameStartsWith>String</ContactNameStartsWith>
<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>
<DebtorID>String</DebtorID>
<DebtorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DebtorIDBetween>
<DebtorIDContains>String</DebtorIDContains>
<DebtorIDEndsWith>String</DebtorIDEndsWith>
<DebtorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DebtorIDIn>
<DebtorIDLike>String</DebtorIDLike>
<DebtorIDStartsWith>String</DebtorIDStartsWith>
<Details>String</Details>
<DetailsBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DetailsBetween>
<DetailsContains>String</DetailsContains>
<DetailsEndsWith>String</DetailsEndsWith>
<DetailsIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DetailsIn>
<DetailsLike>String</DetailsLike>
<DetailsStartsWith>String</DetailsStartsWith>
<IncidentDate>0001-01-01T00:00:00</IncidentDate>
<IncidentDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</IncidentDateBetween>
<IncidentDateGreaterThan>0001-01-01T00:00:00</IncidentDateGreaterThan>
<IncidentDateGreaterThanOrEqualTo>0001-01-01T00:00:00</IncidentDateGreaterThanOrEqualTo>
<IncidentDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</IncidentDateIn>
<IncidentDateLessThan>0001-01-01T00:00:00</IncidentDateLessThan>
<IncidentDateLessThanOrEqualTo>0001-01-01T00:00:00</IncidentDateLessThanOrEqualTo>
<IncidentDateNotEqualTo>0001-01-01T00:00:00</IncidentDateNotEqualTo>
<IncidentNo>String</IncidentNo>
<IncidentNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IncidentNoBetween>
<IncidentNoContains>String</IncidentNoContains>
<IncidentNoEndsWith>String</IncidentNoEndsWith>
<IncidentNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IncidentNoIn>
<IncidentNoLike>String</IncidentNoLike>
<IncidentNoStartsWith>String</IncidentNoStartsWith>
<InvoiceHistoryID>String</InvoiceHistoryID>
<InvoiceHistoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvoiceHistoryIDBetween>
<InvoiceHistoryIDContains>String</InvoiceHistoryIDContains>
<InvoiceHistoryIDEndsWith>String</InvoiceHistoryIDEndsWith>
<InvoiceHistoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvoiceHistoryIDIn>
<InvoiceHistoryIDLike>String</InvoiceHistoryIDLike>
<InvoiceHistoryIDStartsWith>String</InvoiceHistoryIDStartsWith>
<InvoiceID>String</InvoiceID>
<InvoiceIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvoiceIDBetween>
<InvoiceIDContains>String</InvoiceIDContains>
<InvoiceIDEndsWith>String</InvoiceIDEndsWith>
<InvoiceIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvoiceIDIn>
<InvoiceIDLike>String</InvoiceIDLike>
<InvoiceIDStartsWith>String</InvoiceIDStartsWith>
<InvoiceLineID>String</InvoiceLineID>
<InvoiceLineIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvoiceLineIDBetween>
<InvoiceLineIDContains>String</InvoiceLineIDContains>
<InvoiceLineIDEndsWith>String</InvoiceLineIDEndsWith>
<InvoiceLineIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvoiceLineIDIn>
<InvoiceLineIDLike>String</InvoiceLineIDLike>
<InvoiceLineIDStartsWith>String</InvoiceLineIDStartsWith>
<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>
<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>
<SO_IncidentTypes_RecID>String</SO_IncidentTypes_RecID>
<SO_IncidentTypes_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SO_IncidentTypes_RecIDBetween>
<SO_IncidentTypes_RecIDContains>String</SO_IncidentTypes_RecIDContains>
<SO_IncidentTypes_RecIDEndsWith>String</SO_IncidentTypes_RecIDEndsWith>
<SO_IncidentTypes_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SO_IncidentTypes_RecIDIn>
<SO_IncidentTypes_RecIDLike>String</SO_IncidentTypes_RecIDLike>
<SO_IncidentTypes_RecIDStartsWith>String</SO_IncidentTypes_RecIDStartsWith>
</SO_IncidentsQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfSO_Incidents7kRqkrSv 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:SO_Incidents> <d2p1:_x003C_ContactName_x003E_k__BackingField>String</d2p1:_x003C_ContactName_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_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField> <d2p1:_x003C_Details_x003E_k__BackingField>String</d2p1:_x003C_Details_x003E_k__BackingField> <d2p1:_x003C_IncidentDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_IncidentDate_x003E_k__BackingField> <d2p1:_x003C_IncidentNo_x003E_k__BackingField>String</d2p1:_x003C_IncidentNo_x003E_k__BackingField> <d2p1:_x003C_InvoiceHistoryID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceHistoryID_x003E_k__BackingField> <d2p1:_x003C_InvoiceID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceID_x003E_k__BackingField> <d2p1:_x003C_InvoiceLineID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceLineID_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_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField> <d2p1:_x003C_SO_IncidentTypes_RecID_x003E_k__BackingField>String</d2p1:_x003C_SO_IncidentTypes_RecID_x003E_k__BackingField> </d2p1:SO_Incidents> </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> </QueryResponseOfSO_Incidents7kRqkrSv>