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 | |
InventoryID | query | string | No | |
InventoryIDStartsWith | query | string | No | |
InventoryIDEndsWith | query | string | No | |
InventoryIDContains | query | string | No | |
InventoryIDLike | query | string | No | |
InventoryIDBetween | query | string[] | No | |
InventoryIDIn | query | string[] | No | |
UpSellInventoryID | query | string | No | |
UpSellInventoryIDStartsWith | query | string | No | |
UpSellInventoryIDEndsWith | query | string | No | |
UpSellInventoryIDContains | query | string | No | |
UpSellInventoryIDLike | query | string | No | |
UpSellInventoryIDBetween | query | string[] | No | |
UpSellInventoryIDIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
PrimaryCategoryID | query | string | No | |
PrimaryCategoryIDStartsWith | query | string | No | |
PrimaryCategoryIDEndsWith | query | string | No | |
PrimaryCategoryIDContains | query | string | No | |
PrimaryCategoryIDLike | query | string | No | |
PrimaryCategoryIDBetween | query | string[] | No | |
PrimaryCategoryIDIn | query | string[] | No | |
SecondaryCategoryID | query | string | No | |
SecondaryCategoryIDStartsWith | query | string | No | |
SecondaryCategoryIDEndsWith | query | string | No | |
SecondaryCategoryIDContains | query | string | No | |
SecondaryCategoryIDLike | query | string | No | |
SecondaryCategoryIDBetween | query | string[] | No | |
SecondaryCategoryIDIn | query | string[] | No | |
Quantity | query | decimal? | No | |
QuantityGreaterThanOrEqualTo | query | decimal? | No | |
QuantityGreaterThan | query | decimal? | No | |
QuantityLessThan | query | decimal? | No | |
QuantityLessThanOrEqualTo | query | decimal? | No | |
QuantityNotEqualTo | query | decimal? | No | |
QuantityBetween | query | Nullable<Decimal>[] | No | |
QuantityIn | query | Nullable<Decimal>[] | 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 | |
InventoryID | form | string | No | |
UpSellInventoryID | form | string | No | |
Description | form | string | No | |
PrimaryCategoryID | form | string | No | |
SecondaryCategoryID | form | string | No | |
Quantity | form | decimal? | 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_UpSellQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<IN_UpSellQuery 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>
<Description>String</Description>
<DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DescriptionBetween>
<DescriptionContains>String</DescriptionContains>
<DescriptionEndsWith>String</DescriptionEndsWith>
<DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DescriptionIn>
<DescriptionLike>String</DescriptionLike>
<DescriptionStartsWith>String</DescriptionStartsWith>
<InventoryID>String</InventoryID>
<InventoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InventoryIDBetween>
<InventoryIDContains>String</InventoryIDContains>
<InventoryIDEndsWith>String</InventoryIDEndsWith>
<InventoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InventoryIDIn>
<InventoryIDLike>String</InventoryIDLike>
<InventoryIDStartsWith>String</InventoryIDStartsWith>
<PrimaryCategoryID>String</PrimaryCategoryID>
<PrimaryCategoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PrimaryCategoryIDBetween>
<PrimaryCategoryIDContains>String</PrimaryCategoryIDContains>
<PrimaryCategoryIDEndsWith>String</PrimaryCategoryIDEndsWith>
<PrimaryCategoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PrimaryCategoryIDIn>
<PrimaryCategoryIDLike>String</PrimaryCategoryIDLike>
<PrimaryCategoryIDStartsWith>String</PrimaryCategoryIDStartsWith>
<Quantity>0</Quantity>
<QuantityBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</QuantityBetween>
<QuantityGreaterThan>0</QuantityGreaterThan>
<QuantityGreaterThanOrEqualTo>0</QuantityGreaterThanOrEqualTo>
<QuantityIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</QuantityIn>
<QuantityLessThan>0</QuantityLessThan>
<QuantityLessThanOrEqualTo>0</QuantityLessThanOrEqualTo>
<QuantityNotEqualTo>0</QuantityNotEqualTo>
<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>
<SecondaryCategoryID>String</SecondaryCategoryID>
<SecondaryCategoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SecondaryCategoryIDBetween>
<SecondaryCategoryIDContains>String</SecondaryCategoryIDContains>
<SecondaryCategoryIDEndsWith>String</SecondaryCategoryIDEndsWith>
<SecondaryCategoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SecondaryCategoryIDIn>
<SecondaryCategoryIDLike>String</SecondaryCategoryIDLike>
<SecondaryCategoryIDStartsWith>String</SecondaryCategoryIDStartsWith>
<UpSellInventoryID>String</UpSellInventoryID>
<UpSellInventoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</UpSellInventoryIDBetween>
<UpSellInventoryIDContains>String</UpSellInventoryIDContains>
<UpSellInventoryIDEndsWith>String</UpSellInventoryIDEndsWith>
<UpSellInventoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</UpSellInventoryIDIn>
<UpSellInventoryIDLike>String</UpSellInventoryIDLike>
<UpSellInventoryIDStartsWith>String</UpSellInventoryIDStartsWith>
</IN_UpSellQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfIN_UpSell7kRqkrSv 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_UpSell> <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField> <d2p1:_x003C_InventoryID_x003E_k__BackingField>String</d2p1:_x003C_InventoryID_x003E_k__BackingField> <d2p1:_x003C_PrimaryCategoryID_x003E_k__BackingField>String</d2p1:_x003C_PrimaryCategoryID_x003E_k__BackingField> <d2p1:_x003C_Quantity_x003E_k__BackingField>0</d2p1:_x003C_Quantity_x003E_k__BackingField> <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField> <d2p1:_x003C_SecondaryCategoryID_x003E_k__BackingField>String</d2p1:_x003C_SecondaryCategoryID_x003E_k__BackingField> <d2p1:_x003C_UpSellInventoryID_x003E_k__BackingField>String</d2p1:_x003C_UpSellInventoryID_x003E_k__BackingField> </d2p1:IN_UpSell> </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_UpSell7kRqkrSv>