Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AllocLineID | query | string | No | |
AllocLineIDStartsWith | query | string | No | |
AllocLineIDEndsWith | query | string | No | |
AllocLineIDContains | query | string | No | |
AllocLineIDLike | query | string | No | |
AllocLineIDBetween | query | string[] | No | |
AllocLineIDIn | query | string[] | No | |
AllocID | query | string | No | |
AllocIDStartsWith | query | string | No | |
AllocIDEndsWith | query | string | No | |
AllocIDContains | query | string | No | |
AllocIDLike | query | string | No | |
AllocIDBetween | query | string[] | No | |
AllocIDIn | query | string[] | No | |
AllocDate | query | DateTime? | No | |
AllocDateGreaterThanOrEqualTo | query | DateTime? | No | |
AllocDateGreaterThan | query | DateTime? | No | |
AllocDateLessThan | query | DateTime? | No | |
AllocDateLessThanOrEqualTo | query | DateTime? | No | |
AllocDateNotEqualTo | query | DateTime? | No | |
AllocDateBetween | query | Nullable<DateTime>[] | No | |
AllocDateIn | query | Nullable<DateTime>[] | No | |
InvoiceNo | query | string | No | |
InvoiceNoStartsWith | query | string | No | |
InvoiceNoEndsWith | query | string | No | |
InvoiceNoContains | query | string | No | |
InvoiceNoLike | query | string | No | |
InvoiceNoBetween | query | string[] | No | |
InvoiceNoIn | query | string[] | No | |
OrderNo | query | string | No | |
OrderNoStartsWith | query | string | No | |
OrderNoEndsWith | query | string | No | |
OrderNoContains | query | string | No | |
OrderNoLike | query | string | No | |
OrderNoBetween | query | string[] | No | |
OrderNoIn | 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 | |
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 | |
Price | query | decimal? | No | |
PriceGreaterThanOrEqualTo | query | decimal? | No | |
PriceGreaterThan | query | decimal? | No | |
PriceLessThan | query | decimal? | No | |
PriceLessThanOrEqualTo | query | decimal? | No | |
PriceNotEqualTo | query | decimal? | No | |
PriceBetween | query | Nullable<Decimal>[] | No | |
PriceIn | query | Nullable<Decimal>[] | No | |
EstBOValue | query | decimal? | No | |
EstBOValueGreaterThanOrEqualTo | query | decimal? | No | |
EstBOValueGreaterThan | query | decimal? | No | |
EstBOValueLessThan | query | decimal? | No | |
EstBOValueLessThanOrEqualTo | query | decimal? | No | |
EstBOValueNotEqualTo | query | decimal? | No | |
EstBOValueBetween | query | Nullable<Decimal>[] | No | |
EstBOValueIn | query | Nullable<Decimal>[] | No | |
Priority | query | DateTime? | No | |
PriorityGreaterThanOrEqualTo | query | DateTime? | No | |
PriorityGreaterThan | query | DateTime? | No | |
PriorityLessThan | query | DateTime? | No | |
PriorityLessThanOrEqualTo | query | DateTime? | No | |
PriorityNotEqualTo | query | DateTime? | No | |
PriorityBetween | query | Nullable<DateTime>[] | No | |
PriorityIn | query | Nullable<DateTime>[] | No | |
BackOrderMode | query | short? | No | |
BackOrderModeGreaterThanOrEqualTo | query | short? | No | |
BackOrderModeGreaterThan | query | short? | No | |
BackOrderModeLessThan | query | short? | No | |
BackOrderModeLessThanOrEqualTo | query | short? | No | |
BackOrderModeNotEqualTo | query | short? | No | |
BackOrderModeBetween | query | short[] | No | |
BackOrderModeIn | query | short[] | No | |
SourceType | query | short? | No | |
SourceTypeGreaterThanOrEqualTo | query | short? | No | |
SourceTypeGreaterThan | query | short? | No | |
SourceTypeLessThan | query | short? | No | |
SourceTypeLessThanOrEqualTo | query | short? | No | |
SourceTypeNotEqualTo | query | short? | No | |
SourceTypeBetween | query | short[] | No | |
SourceTypeIn | query | short[] | 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 | Nullable<Int32>[] | No | |
PriorityWeightIn | query | Nullable<Int32>[] | 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 |
---|---|---|---|---|
AllocLineID | form | string | No | |
AllocID | form | string | No | |
AllocDate | form | DateTime? | No | |
InvoiceNo | form | string | No | |
OrderNo | form | string | No | |
DebtorID | form | string | No | |
Quantity | form | decimal? | No | |
Price | form | decimal? | No | |
EstBOValue | form | decimal? | No | |
Priority | form | DateTime? | No | |
BackOrderMode | form | short | No | |
SourceType | form | short | No | |
PriorityWeight | form | int? | 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_BackOrderAllocLinesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<IN_BackOrderAllocLinesQuery 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>
<AllocDate>0001-01-01T00:00:00</AllocDate>
<AllocDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</AllocDateBetween>
<AllocDateGreaterThan>0001-01-01T00:00:00</AllocDateGreaterThan>
<AllocDateGreaterThanOrEqualTo>0001-01-01T00:00:00</AllocDateGreaterThanOrEqualTo>
<AllocDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</AllocDateIn>
<AllocDateLessThan>0001-01-01T00:00:00</AllocDateLessThan>
<AllocDateLessThanOrEqualTo>0001-01-01T00:00:00</AllocDateLessThanOrEqualTo>
<AllocDateNotEqualTo>0001-01-01T00:00:00</AllocDateNotEqualTo>
<AllocID>String</AllocID>
<AllocIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AllocIDBetween>
<AllocIDContains>String</AllocIDContains>
<AllocIDEndsWith>String</AllocIDEndsWith>
<AllocIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AllocIDIn>
<AllocIDLike>String</AllocIDLike>
<AllocIDStartsWith>String</AllocIDStartsWith>
<AllocLineID>String</AllocLineID>
<AllocLineIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AllocLineIDBetween>
<AllocLineIDContains>String</AllocLineIDContains>
<AllocLineIDEndsWith>String</AllocLineIDEndsWith>
<AllocLineIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AllocLineIDIn>
<AllocLineIDLike>String</AllocLineIDLike>
<AllocLineIDStartsWith>String</AllocLineIDStartsWith>
<BackOrderMode>0</BackOrderMode>
<BackOrderModeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</BackOrderModeBetween>
<BackOrderModeGreaterThan>0</BackOrderModeGreaterThan>
<BackOrderModeGreaterThanOrEqualTo>0</BackOrderModeGreaterThanOrEqualTo>
<BackOrderModeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</BackOrderModeIn>
<BackOrderModeLessThan>0</BackOrderModeLessThan>
<BackOrderModeLessThanOrEqualTo>0</BackOrderModeLessThanOrEqualTo>
<BackOrderModeNotEqualTo>0</BackOrderModeNotEqualTo>
<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>
<EstBOValue>0</EstBOValue>
<EstBOValueBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</EstBOValueBetween>
<EstBOValueGreaterThan>0</EstBOValueGreaterThan>
<EstBOValueGreaterThanOrEqualTo>0</EstBOValueGreaterThanOrEqualTo>
<EstBOValueIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</EstBOValueIn>
<EstBOValueLessThan>0</EstBOValueLessThan>
<EstBOValueLessThanOrEqualTo>0</EstBOValueLessThanOrEqualTo>
<EstBOValueNotEqualTo>0</EstBOValueNotEqualTo>
<InvoiceNo>String</InvoiceNo>
<InvoiceNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvoiceNoBetween>
<InvoiceNoContains>String</InvoiceNoContains>
<InvoiceNoEndsWith>String</InvoiceNoEndsWith>
<InvoiceNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvoiceNoIn>
<InvoiceNoLike>String</InvoiceNoLike>
<InvoiceNoStartsWith>String</InvoiceNoStartsWith>
<OrderNo>String</OrderNo>
<OrderNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OrderNoBetween>
<OrderNoContains>String</OrderNoContains>
<OrderNoEndsWith>String</OrderNoEndsWith>
<OrderNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OrderNoIn>
<OrderNoLike>String</OrderNoLike>
<OrderNoStartsWith>String</OrderNoStartsWith>
<Price>0</Price>
<PriceBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</PriceBetween>
<PriceGreaterThan>0</PriceGreaterThan>
<PriceGreaterThanOrEqualTo>0</PriceGreaterThanOrEqualTo>
<PriceIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</PriceIn>
<PriceLessThan>0</PriceLessThan>
<PriceLessThanOrEqualTo>0</PriceLessThanOrEqualTo>
<PriceNotEqualTo>0</PriceNotEqualTo>
<Priority>0001-01-01T00:00:00</Priority>
<PriorityBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</PriorityBetween>
<PriorityGreaterThan>0001-01-01T00:00:00</PriorityGreaterThan>
<PriorityGreaterThanOrEqualTo>0001-01-01T00:00:00</PriorityGreaterThanOrEqualTo>
<PriorityIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</PriorityIn>
<PriorityLessThan>0001-01-01T00:00:00</PriorityLessThan>
<PriorityLessThanOrEqualTo>0001-01-01T00:00:00</PriorityLessThanOrEqualTo>
<PriorityNotEqualTo>0001-01-01T00:00:00</PriorityNotEqualTo>
<PriorityWeight>0</PriorityWeight>
<PriorityWeightBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:int>0</d2p1:int>
</PriorityWeightBetween>
<PriorityWeightGreaterThan>0</PriorityWeightGreaterThan>
<PriorityWeightGreaterThanOrEqualTo>0</PriorityWeightGreaterThanOrEqualTo>
<PriorityWeightIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:int>0</d2p1:int>
</PriorityWeightIn>
<PriorityWeightLessThan>0</PriorityWeightLessThan>
<PriorityWeightLessThanOrEqualTo>0</PriorityWeightLessThanOrEqualTo>
<PriorityWeightNotEqualTo>0</PriorityWeightNotEqualTo>
<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>
<SourceType>0</SourceType>
<SourceTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</SourceTypeBetween>
<SourceTypeGreaterThan>0</SourceTypeGreaterThan>
<SourceTypeGreaterThanOrEqualTo>0</SourceTypeGreaterThanOrEqualTo>
<SourceTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:short>0</d2p1:short>
</SourceTypeIn>
<SourceTypeLessThan>0</SourceTypeLessThan>
<SourceTypeLessThanOrEqualTo>0</SourceTypeLessThanOrEqualTo>
<SourceTypeNotEqualTo>0</SourceTypeNotEqualTo>
</IN_BackOrderAllocLinesQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfIN_BackOrderAllocLines7kRqkrSv 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_BackOrderAllocLines> <d2p1:_x003C_AllocDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_AllocDate_x003E_k__BackingField> <d2p1:_x003C_AllocID_x003E_k__BackingField>String</d2p1:_x003C_AllocID_x003E_k__BackingField> <d2p1:_x003C_AllocLineID_x003E_k__BackingField>String</d2p1:_x003C_AllocLineID_x003E_k__BackingField> <d2p1:_x003C_BackOrderMode_x003E_k__BackingField>0</d2p1:_x003C_BackOrderMode_x003E_k__BackingField> <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField> <d2p1:_x003C_EstBOValue_x003E_k__BackingField>0</d2p1:_x003C_EstBOValue_x003E_k__BackingField> <d2p1:_x003C_InvoiceNo_x003E_k__BackingField>String</d2p1:_x003C_InvoiceNo_x003E_k__BackingField> <d2p1:_x003C_OrderNo_x003E_k__BackingField>String</d2p1:_x003C_OrderNo_x003E_k__BackingField> <d2p1:_x003C_Price_x003E_k__BackingField>0</d2p1:_x003C_Price_x003E_k__BackingField> <d2p1:_x003C_PriorityWeight_x003E_k__BackingField>0</d2p1:_x003C_PriorityWeight_x003E_k__BackingField> <d2p1:_x003C_Priority_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_Priority_x003E_k__BackingField> <d2p1:_x003C_Quantity_x003E_k__BackingField>0</d2p1:_x003C_Quantity_x003E_k__BackingField> <d2p1:_x003C_SourceType_x003E_k__BackingField>0</d2p1:_x003C_SourceType_x003E_k__BackingField> </d2p1:IN_BackOrderAllocLines> </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_BackOrderAllocLines7kRqkrSv>