JiwaAPI

<back to all web services

IN_LogicalQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/IN_LogicalRetrieves a list of logical warehouses.
IN_LogicalQuery Parameters:
NameParameterData TypeRequiredDescription
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
IN_PhysicalIDquerystringNo
IN_PhysicalIDStartsWithquerystringNo
IN_PhysicalIDEndsWithquerystringNo
IN_PhysicalIDContainsquerystringNo
IN_PhysicalIDLikequerystringNo
IN_PhysicalIDBetweenquerystring[]No
IN_PhysicalIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
LedgerMaskquerystringNo
LedgerMaskStartsWithquerystringNo
LedgerMaskEndsWithquerystringNo
LedgerMaskContainsquerystringNo
LedgerMaskLikequerystringNo
LedgerMaskBetweenquerystring[]No
LedgerMaskInquerystring[]No
WarehouseCodequerystringNo
WarehouseCodeStartsWithquerystringNo
WarehouseCodeEndsWithquerystringNo
WarehouseCodeContainsquerystringNo
WarehouseCodeLikequerystringNo
WarehouseCodeBetweenquerystring[]No
WarehouseCodeInquerystring[]No
InTransitquerybool?No
DefaultInTransitquerybool?No
IN_Region_RecIDquerystringNo
IN_Region_RecIDStartsWithquerystringNo
IN_Region_RecIDEndsWithquerystringNo
IN_Region_RecIDContainsquerystringNo
IN_Region_RecIDLikequerystringNo
IN_Region_RecIDBetweenquerystring[]No
IN_Region_RecIDInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
Colourqueryint?No
ColourGreaterThanOrEqualToqueryint?No
ColourGreaterThanqueryint?No
ColourLessThanqueryint?No
ColourLessThanOrEqualToqueryint?No
ColourNotEqualToqueryint?No
ColourBetweenqueryNullable<Int32>[]No
ColourInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Logical Parameters:
NameParameterData TypeRequiredDescription
IN_LogicalIDformstringNo
IN_PhysicalIDformstringNo
LastSavedDateTimeformDateTimeNo
DescriptionformstringNo
LedgerMaskformstringNo
WarehouseCodeformstringNo
InTransitformbool?No
DefaultInTransitformbool?No
IN_Region_RecIDformstringNo
ItemNoformintNo
RowHashformbyte[]No
Colourformint?No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Queries/IN_Logical HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfIN_Logical7kRqkrSv 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_Logical>
      <d2p1:_x003C_Colour_x003E_k__BackingField>0</d2p1:_x003C_Colour_x003E_k__BackingField>
      <d2p1:_x003C_DefaultInTransit_x003E_k__BackingField>false</d2p1:_x003C_DefaultInTransit_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <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_IN_Region_RecID_x003E_k__BackingField>String</d2p1:_x003C_IN_Region_RecID_x003E_k__BackingField>
      <d2p1:_x003C_InTransit_x003E_k__BackingField>false</d2p1:_x003C_InTransit_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_LedgerMask_x003E_k__BackingField>String</d2p1:_x003C_LedgerMask_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_WarehouseCode_x003E_k__BackingField>String</d2p1:_x003C_WarehouseCode_x003E_k__BackingField>
    </d2p1:IN_Logical>
  </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_Logical7kRqkrSv>