Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IN_LogicalID | query | string | No | |
IN_LogicalIDStartsWith | query | string | No | |
IN_LogicalIDEndsWith | query | string | No | |
IN_LogicalIDContains | query | string | No | |
IN_LogicalIDLike | query | string | No | |
IN_LogicalIDBetween | query | string[] | No | |
IN_LogicalIDIn | query | string[] | No | |
IN_PhysicalID | query | string | No | |
IN_PhysicalIDStartsWith | query | string | No | |
IN_PhysicalIDEndsWith | query | string | No | |
IN_PhysicalIDContains | query | string | No | |
IN_PhysicalIDLike | query | string | No | |
IN_PhysicalIDBetween | query | string[] | No | |
IN_PhysicalIDIn | query | string[] | No | |
LogicalWarehouseDesciption | query | string | No | |
LogicalWarehouseDesciptionStartsWith | query | string | No | |
LogicalWarehouseDesciptionEndsWith | query | string | No | |
LogicalWarehouseDesciptionContains | query | string | No | |
LogicalWarehouseDesciptionLike | query | string | No | |
LogicalWarehouseDesciptionBetween | query | string[] | No | |
LogicalWarehouseDesciptionIn | query | string[] | No | |
PhysicalWarehouseDesciption | query | string | No | |
PhysicalWarehouseDesciptionStartsWith | query | string | No | |
PhysicalWarehouseDesciptionEndsWith | query | string | No | |
PhysicalWarehouseDesciptionContains | query | string | No | |
PhysicalWarehouseDesciptionLike | query | string | No | |
PhysicalWarehouseDesciptionBetween | query | string[] | No | |
PhysicalWarehouseDesciptionIn | 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 |
---|---|---|---|---|
IN_LogicalID | form | string | No | |
IN_PhysicalID | form | string | No | |
LogicalWarehouseDesciption | form | string | No | |
PhysicalWarehouseDesciption | 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/v_JIWA_DefaultOrderLocationsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<v_JIWA_DefaultOrderLocationsQuery 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>
<IN_LogicalID>String</IN_LogicalID>
<IN_LogicalIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IN_LogicalIDBetween>
<IN_LogicalIDContains>String</IN_LogicalIDContains>
<IN_LogicalIDEndsWith>String</IN_LogicalIDEndsWith>
<IN_LogicalIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IN_LogicalIDIn>
<IN_LogicalIDLike>String</IN_LogicalIDLike>
<IN_LogicalIDStartsWith>String</IN_LogicalIDStartsWith>
<IN_PhysicalID>String</IN_PhysicalID>
<IN_PhysicalIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IN_PhysicalIDBetween>
<IN_PhysicalIDContains>String</IN_PhysicalIDContains>
<IN_PhysicalIDEndsWith>String</IN_PhysicalIDEndsWith>
<IN_PhysicalIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IN_PhysicalIDIn>
<IN_PhysicalIDLike>String</IN_PhysicalIDLike>
<IN_PhysicalIDStartsWith>String</IN_PhysicalIDStartsWith>
<LogicalWarehouseDesciption>String</LogicalWarehouseDesciption>
<LogicalWarehouseDesciptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</LogicalWarehouseDesciptionBetween>
<LogicalWarehouseDesciptionContains>String</LogicalWarehouseDesciptionContains>
<LogicalWarehouseDesciptionEndsWith>String</LogicalWarehouseDesciptionEndsWith>
<LogicalWarehouseDesciptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</LogicalWarehouseDesciptionIn>
<LogicalWarehouseDesciptionLike>String</LogicalWarehouseDesciptionLike>
<LogicalWarehouseDesciptionStartsWith>String</LogicalWarehouseDesciptionStartsWith>
<PhysicalWarehouseDesciption>String</PhysicalWarehouseDesciption>
<PhysicalWarehouseDesciptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PhysicalWarehouseDesciptionBetween>
<PhysicalWarehouseDesciptionContains>String</PhysicalWarehouseDesciptionContains>
<PhysicalWarehouseDesciptionEndsWith>String</PhysicalWarehouseDesciptionEndsWith>
<PhysicalWarehouseDesciptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PhysicalWarehouseDesciptionIn>
<PhysicalWarehouseDesciptionLike>String</PhysicalWarehouseDesciptionLike>
<PhysicalWarehouseDesciptionStartsWith>String</PhysicalWarehouseDesciptionStartsWith>
</v_JIWA_DefaultOrderLocationsQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfv_JIWA_DefaultOrderLocations7kRqkrSv 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:v_JIWA_DefaultOrderLocations> <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_x003E_k__BackingField> <d2p1:_x003C_IN_PhysicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_PhysicalID_x003E_k__BackingField> <d2p1:_x003C_LogicalWarehouseDesciption_x003E_k__BackingField>String</d2p1:_x003C_LogicalWarehouseDesciption_x003E_k__BackingField> <d2p1:_x003C_PhysicalWarehouseDesciption_x003E_k__BackingField>String</d2p1:_x003C_PhysicalWarehouseDesciption_x003E_k__BackingField> </d2p1:v_JIWA_DefaultOrderLocations> </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> </QueryResponseOfv_JIWA_DefaultOrderLocations7kRqkrSv>