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 | |
PriorityDescription | query | string | No | |
PriorityDescriptionStartsWith | query | string | No | |
PriorityDescriptionEndsWith | query | string | No | |
PriorityDescriptionContains | query | string | No | |
PriorityDescriptionLike | query | string | No | |
PriorityDescriptionBetween | query | string[] | No | |
PriorityDescriptionIn | query | string[] | No | |
PriorityWeight | query | int? | No | |
PriorityWeightGreaterThanOrEqualTo | query | int? | No | |
PriorityWeightGreaterThan | query | int? | No | |
PriorityWeightLessThan | query | int? | No | |
PriorityWeightLessThanOrEqualTo | query | int? | No | |
PriorityWeightNotEqualTo | query | int? | No | |
PriorityWeightBetween | query | int[] | No | |
PriorityWeightIn | query | int[] | No | |
DefaultPriority | query | bool? | 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 |
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 | |
PriorityDescription | form | string | No | |
PriorityWeight | form | int | No | |
DefaultPriority | form | bool? | No | |
LastSavedDateTime | 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/BO_PrioritiesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BO_PrioritiesQuery 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>
<DefaultPriority>false</DefaultPriority>
<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>
<PriorityDescription>String</PriorityDescription>
<PriorityDescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PriorityDescriptionBetween>
<PriorityDescriptionContains>String</PriorityDescriptionContains>
<PriorityDescriptionEndsWith>String</PriorityDescriptionEndsWith>
<PriorityDescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PriorityDescriptionIn>
<PriorityDescriptionLike>String</PriorityDescriptionLike>
<PriorityDescriptionStartsWith>String</PriorityDescriptionStartsWith>
<PriorityWeight>0</PriorityWeight>
<PriorityWeightBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</PriorityWeightBetween>
<PriorityWeightGreaterThan>0</PriorityWeightGreaterThan>
<PriorityWeightGreaterThanOrEqualTo>0</PriorityWeightGreaterThanOrEqualTo>
<PriorityWeightIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</PriorityWeightIn>
<PriorityWeightLessThan>0</PriorityWeightLessThan>
<PriorityWeightLessThanOrEqualTo>0</PriorityWeightLessThanOrEqualTo>
<PriorityWeightNotEqualTo>0</PriorityWeightNotEqualTo>
<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>
</BO_PrioritiesQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfBO_Priorities7kRqkrSv 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_Priorities> <d2p1:_x003C_DefaultPriority_x003E_k__BackingField>false</d2p1:_x003C_DefaultPriority_x003E_k__BackingField> <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField> <d2p1:_x003C_PriorityDescription_x003E_k__BackingField>String</d2p1:_x003C_PriorityDescription_x003E_k__BackingField> <d2p1:_x003C_PriorityWeight_x003E_k__BackingField>0</d2p1:_x003C_PriorityWeight_x003E_k__BackingField> <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField> </d2p1:BO_Priorities> </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_Priorities7kRqkrSv>