JiwaAPI

<back to all web services

v_Oscar_StockLevelQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/OscarStockLevelsQueryable list stock levels for Oscar
v_Oscar_StockLevelQuery Parameters:
NameParameterData TypeRequiredDescription
IN_WarehouseSOHIDquerystringNo
IN_WarehouseSOHIDStartsWithquerystringNo
IN_WarehouseSOHIDEndsWithquerystringNo
IN_WarehouseSOHIDContainsquerystringNo
IN_WarehouseSOHIDLikequerystringNo
IN_WarehouseSOHIDBetweenquerystring[]No
IN_WarehouseSOHIDInquerystring[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
AAPIquerystringNo
AAPIStartsWithquerystringNo
AAPIEndsWithquerystringNo
AAPIContainsquerystringNo
AAPILikequerystringNo
AAPIBetweenquerystring[]No
AAPIInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
LogicalWarehouseIDquerystringNo
LogicalWarehouseIDStartsWithquerystringNo
LogicalWarehouseIDEndsWithquerystringNo
LogicalWarehouseIDContainsquerystringNo
LogicalWarehouseIDLikequerystringNo
LogicalWarehouseIDBetweenquerystring[]No
LogicalWarehouseIDInquerystring[]No
LogicalWarehouseDescriptionquerystringNo
LogicalWarehouseDescriptionStartsWithquerystringNo
LogicalWarehouseDescriptionEndsWithquerystringNo
LogicalWarehouseDescriptionContainsquerystringNo
LogicalWarehouseDescriptionLikequerystringNo
LogicalWarehouseDescriptionBetweenquerystring[]No
LogicalWarehouseDescriptionInquerystring[]No
LogicalWarehouseCodequerystringNo
LogicalWarehouseCodeStartsWithquerystringNo
LogicalWarehouseCodeEndsWithquerystringNo
LogicalWarehouseCodeContainsquerystringNo
LogicalWarehouseCodeLikequerystringNo
LogicalWarehouseCodeBetweenquerystring[]No
LogicalWarehouseCodeInquerystring[]No
LogicalWarehouseInTransitquerybool?No
PhysicalWarehouseIDquerystringNo
PhysicalWarehouseIDStartsWithquerystringNo
PhysicalWarehouseIDEndsWithquerystringNo
PhysicalWarehouseIDContainsquerystringNo
PhysicalWarehouseIDLikequerystringNo
PhysicalWarehouseIDBetweenquerystring[]No
PhysicalWarehouseIDInquerystring[]No
PhysicalWarehouseDescriptionquerystringNo
PhysicalWarehouseDescriptionStartsWithquerystringNo
PhysicalWarehouseDescriptionEndsWithquerystringNo
PhysicalWarehouseDescriptionContainsquerystringNo
PhysicalWarehouseDescriptionLikequerystringNo
PhysicalWarehouseDescriptionBetweenquerystring[]No
PhysicalWarehouseDescriptionInquerystring[]No
PhysicalWarehouseAddress1querystringNo
PhysicalWarehouseAddress1StartsWithquerystringNo
PhysicalWarehouseAddress1EndsWithquerystringNo
PhysicalWarehouseAddress1ContainsquerystringNo
PhysicalWarehouseAddress1LikequerystringNo
PhysicalWarehouseAddress1Betweenquerystring[]No
PhysicalWarehouseAddress1Inquerystring[]No
PhysicalWarehouseAddress2querystringNo
PhysicalWarehouseAddress2StartsWithquerystringNo
PhysicalWarehouseAddress2EndsWithquerystringNo
PhysicalWarehouseAddress2ContainsquerystringNo
PhysicalWarehouseAddress2LikequerystringNo
PhysicalWarehouseAddress2Betweenquerystring[]No
PhysicalWarehouseAddress2Inquerystring[]No
PhysicalWarehouseAddress3querystringNo
PhysicalWarehouseAddress3StartsWithquerystringNo
PhysicalWarehouseAddress3EndsWithquerystringNo
PhysicalWarehouseAddress3ContainsquerystringNo
PhysicalWarehouseAddress3LikequerystringNo
PhysicalWarehouseAddress3Betweenquerystring[]No
PhysicalWarehouseAddress3Inquerystring[]No
PhysicalWarehouseAddress4querystringNo
PhysicalWarehouseAddress4StartsWithquerystringNo
PhysicalWarehouseAddress4EndsWithquerystringNo
PhysicalWarehouseAddress4ContainsquerystringNo
PhysicalWarehouseAddress4LikequerystringNo
PhysicalWarehouseAddress4Betweenquerystring[]No
PhysicalWarehouseAddress4Inquerystring[]No
PhysicalWarehousePostcodequerystringNo
PhysicalWarehousePostcodeStartsWithquerystringNo
PhysicalWarehousePostcodeEndsWithquerystringNo
PhysicalWarehousePostcodeContainsquerystringNo
PhysicalWarehousePostcodeLikequerystringNo
PhysicalWarehousePostcodeBetweenquerystring[]No
PhysicalWarehousePostcodeInquerystring[]No
PhysicalWarehouseTelephonequerystringNo
PhysicalWarehouseTelephoneStartsWithquerystringNo
PhysicalWarehouseTelephoneEndsWithquerystringNo
PhysicalWarehouseTelephoneContainsquerystringNo
PhysicalWarehouseTelephoneLikequerystringNo
PhysicalWarehouseTelephoneBetweenquerystring[]No
PhysicalWarehouseTelephoneInquerystring[]No
QuantityLeftquerydecimal?No
QuantityLeftGreaterThanOrEqualToquerydecimal?No
QuantityLeftGreaterThanquerydecimal?No
QuantityLeftLessThanquerydecimal?No
QuantityLeftLessThanOrEqualToquerydecimal?No
QuantityLeftNotEqualToquerydecimal?No
QuantityLeftBetweenqueryNullable<Decimal>[]No
QuantityLeftInqueryNullable<Decimal>[]No
QuantityAllocatedquerydecimal?No
QuantityAllocatedGreaterThanOrEqualToquerydecimal?No
QuantityAllocatedGreaterThanquerydecimal?No
QuantityAllocatedLessThanquerydecimal?No
QuantityAllocatedLessThanOrEqualToquerydecimal?No
QuantityAllocatedNotEqualToquerydecimal?No
QuantityAllocatedBetweenqueryNullable<Decimal>[]No
QuantityAllocatedInqueryNullable<Decimal>[]No
QuantityAvailablequerydecimal?No
QuantityAvailableGreaterThanOrEqualToquerydecimal?No
QuantityAvailableGreaterThanquerydecimal?No
QuantityAvailableLessThanquerydecimal?No
QuantityAvailableLessThanOrEqualToquerydecimal?No
QuantityAvailableNotEqualToquerydecimal?No
QuantityAvailableBetweenqueryNullable<Decimal>[]No
QuantityAvailableInqueryNullable<Decimal>[]No
Statusqueryshort?No
StatusStartsWithqueryshort?No
StatusEndsWithqueryshort?No
StatusContainsqueryshort?No
StatusLikequeryshort?No
StatusBetweenqueryNullable<Int16>[]No
StatusInqueryNullable<Int16>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_Oscar_StockLevel Parameters:
NameParameterData TypeRequiredDescription
IN_WarehouseSOHIDformstringNo
InventoryIDformstringNo
PartNoformstringNo
AAPIformstringNo
DescriptionformstringNo
LogicalWarehouseIDformstringNo
LogicalWarehouseDescriptionformstringNo
LogicalWarehouseCodeformstringNo
LogicalWarehouseInTransitformbool?No
PhysicalWarehouseIDformstringNo
PhysicalWarehouseDescriptionformstringNo
PhysicalWarehouseAddress1formstringNo
PhysicalWarehouseAddress2formstringNo
PhysicalWarehouseAddress3formstringNo
PhysicalWarehouseAddress4formstringNo
PhysicalWarehousePostcodeformstringNo
PhysicalWarehouseTelephoneformstringNo
QuantityLeftformdecimal?No
QuantityAllocatedformdecimal?No
QuantityAvailableformdecimal?No
Statusformint?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/OscarStockLevels HTTP/1.1 
Host: 10.150.151.12 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfv_Oscar_StockLevel6LgwzCd1 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">
    <d2p1:v_Oscar_StockLevel>
      <d2p1:AAPI>String</d2p1:AAPI>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:IN_WarehouseSOHID>String</d2p1:IN_WarehouseSOHID>
      <d2p1:InventoryID>String</d2p1:InventoryID>
      <d2p1:LogicalWarehouseCode>String</d2p1:LogicalWarehouseCode>
      <d2p1:LogicalWarehouseDescription>String</d2p1:LogicalWarehouseDescription>
      <d2p1:LogicalWarehouseID>String</d2p1:LogicalWarehouseID>
      <d2p1:LogicalWarehouseInTransit>false</d2p1:LogicalWarehouseInTransit>
      <d2p1:PartNo>String</d2p1:PartNo>
      <d2p1:PhysicalWarehouseAddress1>String</d2p1:PhysicalWarehouseAddress1>
      <d2p1:PhysicalWarehouseAddress2>String</d2p1:PhysicalWarehouseAddress2>
      <d2p1:PhysicalWarehouseAddress3>String</d2p1:PhysicalWarehouseAddress3>
      <d2p1:PhysicalWarehouseAddress4>String</d2p1:PhysicalWarehouseAddress4>
      <d2p1:PhysicalWarehouseDescription>String</d2p1:PhysicalWarehouseDescription>
      <d2p1:PhysicalWarehouseID>String</d2p1:PhysicalWarehouseID>
      <d2p1:PhysicalWarehousePostcode>String</d2p1:PhysicalWarehousePostcode>
      <d2p1:PhysicalWarehouseTelephone>String</d2p1:PhysicalWarehouseTelephone>
      <d2p1:QuantityAllocated>0</d2p1:QuantityAllocated>
      <d2p1:QuantityAvailable>0</d2p1:QuantityAvailable>
      <d2p1:QuantityLeft>0</d2p1:QuantityLeft>
      <d2p1:Status>0</d2p1:Status>
    </d2p1:v_Oscar_StockLevel>
  </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_Oscar_StockLevel6LgwzCd1>