JiwaAPI

<back to all web services

v_InventoryQuery

Requires Authentication
v_InventoryQuery Parameters:
NameParameterData TypeRequiredDescription
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
PartNoAndDescriptionquerystringNo
PartNoAndDescriptionStartsWithquerystringNo
PartNoAndDescriptionEndsWithquerystringNo
PartNoAndDescriptionContainsquerystringNo
PartNoAndDescriptionLikequerystringNo
PartNoAndDescriptionBetweenquerystring[]No
PartNoAndDescriptionInquerystring[]No
Category1IDquerystringNo
Category1IDStartsWithquerystringNo
Category1IDEndsWithquerystringNo
Category1IDContainsquerystringNo
Category1IDLikequerystringNo
Category1IDBetweenquerystring[]No
Category1IDInquerystring[]No
Category2IDquerystringNo
Category2IDStartsWithquerystringNo
Category2IDEndsWithquerystringNo
Category2IDContainsquerystringNo
Category2IDLikequerystringNo
Category2IDBetweenquerystring[]No
Category2IDInquerystring[]No
Category3IDquerystringNo
Category3IDStartsWithquerystringNo
Category3IDEndsWithquerystringNo
Category3IDContainsquerystringNo
Category3IDLikequerystringNo
Category3IDBetweenquerystring[]No
Category3IDInquerystring[]No
Category4IDquerystringNo
Category4IDStartsWithquerystringNo
Category4IDEndsWithquerystringNo
Category4IDContainsquerystringNo
Category4IDLikequerystringNo
Category4IDBetweenquerystring[]No
Category4IDInquerystring[]No
Category5IDquerystringNo
Category5IDStartsWithquerystringNo
Category5IDEndsWithquerystringNo
Category5IDContainsquerystringNo
Category5IDLikequerystringNo
Category5IDBetweenquerystring[]No
Category5IDInquerystring[]No
ClassificationIDquerystringNo
ClassificationIDStartsWithquerystringNo
ClassificationIDEndsWithquerystringNo
ClassificationIDContainsquerystringNo
ClassificationIDLikequerystringNo
ClassificationIDBetweenquerystring[]No
ClassificationIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_Inventory Parameters:
NameParameterData TypeRequiredDescription
InventoryIDformstringNo
PartNoformstringNo
DescriptionformstringNo
PartNoAndDescriptionformstringNo
Category1IDformstringNo
Category2IDformstringNo
Category3IDformstringNo
Category4IDformstringNo
Category5IDformstringNo
ClassificationIDformstringNo
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.

POST /xml/reply/v_InventoryQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<v_InventoryQuery 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>
  <Category1ID>String</Category1ID>
  <Category1IDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category1IDBetween>
  <Category1IDContains>String</Category1IDContains>
  <Category1IDEndsWith>String</Category1IDEndsWith>
  <Category1IDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category1IDIn>
  <Category1IDLike>String</Category1IDLike>
  <Category1IDStartsWith>String</Category1IDStartsWith>
  <Category2ID>String</Category2ID>
  <Category2IDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category2IDBetween>
  <Category2IDContains>String</Category2IDContains>
  <Category2IDEndsWith>String</Category2IDEndsWith>
  <Category2IDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category2IDIn>
  <Category2IDLike>String</Category2IDLike>
  <Category2IDStartsWith>String</Category2IDStartsWith>
  <Category3ID>String</Category3ID>
  <Category3IDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category3IDBetween>
  <Category3IDContains>String</Category3IDContains>
  <Category3IDEndsWith>String</Category3IDEndsWith>
  <Category3IDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category3IDIn>
  <Category3IDLike>String</Category3IDLike>
  <Category3IDStartsWith>String</Category3IDStartsWith>
  <Category4ID>String</Category4ID>
  <Category4IDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category4IDBetween>
  <Category4IDContains>String</Category4IDContains>
  <Category4IDEndsWith>String</Category4IDEndsWith>
  <Category4IDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category4IDIn>
  <Category4IDLike>String</Category4IDLike>
  <Category4IDStartsWith>String</Category4IDStartsWith>
  <Category5ID>String</Category5ID>
  <Category5IDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category5IDBetween>
  <Category5IDContains>String</Category5IDContains>
  <Category5IDEndsWith>String</Category5IDEndsWith>
  <Category5IDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Category5IDIn>
  <Category5IDLike>String</Category5IDLike>
  <Category5IDStartsWith>String</Category5IDStartsWith>
  <ClassificationID>String</ClassificationID>
  <ClassificationIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ClassificationIDBetween>
  <ClassificationIDContains>String</ClassificationIDContains>
  <ClassificationIDEndsWith>String</ClassificationIDEndsWith>
  <ClassificationIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ClassificationIDIn>
  <ClassificationIDLike>String</ClassificationIDLike>
  <ClassificationIDStartsWith>String</ClassificationIDStartsWith>
  <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>
  <PartNo>String</PartNo>
  <PartNoAndDescription>String</PartNoAndDescription>
  <PartNoAndDescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PartNoAndDescriptionBetween>
  <PartNoAndDescriptionContains>String</PartNoAndDescriptionContains>
  <PartNoAndDescriptionEndsWith>String</PartNoAndDescriptionEndsWith>
  <PartNoAndDescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PartNoAndDescriptionIn>
  <PartNoAndDescriptionLike>String</PartNoAndDescriptionLike>
  <PartNoAndDescriptionStartsWith>String</PartNoAndDescriptionStartsWith>
  <PartNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PartNoBetween>
  <PartNoContains>String</PartNoContains>
  <PartNoEndsWith>String</PartNoEndsWith>
  <PartNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PartNoIn>
  <PartNoLike>String</PartNoLike>
  <PartNoStartsWith>String</PartNoStartsWith>
</v_InventoryQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfv_Inventory7kRqkrSv 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_Inventory>
      <d2p1:_x003C_Category1ID_x003E_k__BackingField>String</d2p1:_x003C_Category1ID_x003E_k__BackingField>
      <d2p1:_x003C_Category2ID_x003E_k__BackingField>String</d2p1:_x003C_Category2ID_x003E_k__BackingField>
      <d2p1:_x003C_Category3ID_x003E_k__BackingField>String</d2p1:_x003C_Category3ID_x003E_k__BackingField>
      <d2p1:_x003C_Category4ID_x003E_k__BackingField>String</d2p1:_x003C_Category4ID_x003E_k__BackingField>
      <d2p1:_x003C_Category5ID_x003E_k__BackingField>String</d2p1:_x003C_Category5ID_x003E_k__BackingField>
      <d2p1:_x003C_ClassificationID_x003E_k__BackingField>String</d2p1:_x003C_ClassificationID_x003E_k__BackingField>
      <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_PartNoAndDescription_x003E_k__BackingField>String</d2p1:_x003C_PartNoAndDescription_x003E_k__BackingField>
      <d2p1:_x003C_PartNo_x003E_k__BackingField>String</d2p1:_x003C_PartNo_x003E_k__BackingField>
    </d2p1:v_Inventory>
  </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_Inventory7kRqkrSv>