JiwaAPI

<back to all web services

IN_ComponentsQuery

Requires Authentication
IN_ComponentsQuery Parameters:
NameParameterData TypeRequiredDescription
INComponentRecIDquerystringNo
INComponentRecIDStartsWithquerystringNo
INComponentRecIDEndsWithquerystringNo
INComponentRecIDContainsquerystringNo
INComponentRecIDLikequerystringNo
INComponentRecIDBetweenquerystring[]No
INComponentRecIDInquerystring[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
ComponentIDquerystringNo
ComponentIDStartsWithquerystringNo
ComponentIDEndsWithquerystringNo
ComponentIDContainsquerystringNo
ComponentIDLikequerystringNo
ComponentIDBetweenquerystring[]No
ComponentIDInquerystring[]No
Quantityquerydecimal?No
QuantityGreaterThanOrEqualToquerydecimal?No
QuantityGreaterThanquerydecimal?No
QuantityLessThanquerydecimal?No
QuantityLessThanOrEqualToquerydecimal?No
QuantityNotEqualToquerydecimal?No
QuantityBetweenqueryNullable<Decimal>[]No
QuantityInqueryNullable<Decimal>[]No
LineNumberqueryint?No
LineNumberGreaterThanOrEqualToqueryint?No
LineNumberGreaterThanqueryint?No
LineNumberLessThanqueryint?No
LineNumberLessThanOrEqualToqueryint?No
LineNumberNotEqualToqueryint?No
LineNumberBetweenqueryint[]No
LineNumberInqueryint[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Components Parameters:
NameParameterData TypeRequiredDescription
INComponentRecIDformstringNo
InventoryIDformstringNo
ComponentIDformstringNo
Quantityformdecimal?No
LineNumberformintNo
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/IN_ComponentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IN_ComponentsQuery 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>
  <ComponentID>String</ComponentID>
  <ComponentIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ComponentIDBetween>
  <ComponentIDContains>String</ComponentIDContains>
  <ComponentIDEndsWith>String</ComponentIDEndsWith>
  <ComponentIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ComponentIDIn>
  <ComponentIDLike>String</ComponentIDLike>
  <ComponentIDStartsWith>String</ComponentIDStartsWith>
  <INComponentRecID>String</INComponentRecID>
  <INComponentRecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </INComponentRecIDBetween>
  <INComponentRecIDContains>String</INComponentRecIDContains>
  <INComponentRecIDEndsWith>String</INComponentRecIDEndsWith>
  <INComponentRecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </INComponentRecIDIn>
  <INComponentRecIDLike>String</INComponentRecIDLike>
  <INComponentRecIDStartsWith>String</INComponentRecIDStartsWith>
  <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>
  <LineNumber>0</LineNumber>
  <LineNumberBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LineNumberBetween>
  <LineNumberGreaterThan>0</LineNumberGreaterThan>
  <LineNumberGreaterThanOrEqualTo>0</LineNumberGreaterThanOrEqualTo>
  <LineNumberIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LineNumberIn>
  <LineNumberLessThan>0</LineNumberLessThan>
  <LineNumberLessThanOrEqualTo>0</LineNumberLessThanOrEqualTo>
  <LineNumberNotEqualTo>0</LineNumberNotEqualTo>
  <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>
</IN_ComponentsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfIN_Components7kRqkrSv 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_Components>
      <d2p1:_x003C_ComponentID_x003E_k__BackingField>String</d2p1:_x003C_ComponentID_x003E_k__BackingField>
      <d2p1:_x003C_INComponentRecID_x003E_k__BackingField>String</d2p1:_x003C_INComponentRecID_x003E_k__BackingField>
      <d2p1:_x003C_InventoryID_x003E_k__BackingField>String</d2p1:_x003C_InventoryID_x003E_k__BackingField>
      <d2p1:_x003C_LineNumber_x003E_k__BackingField>0</d2p1:_x003C_LineNumber_x003E_k__BackingField>
      <d2p1:_x003C_Quantity_x003E_k__BackingField>0</d2p1:_x003C_Quantity_x003E_k__BackingField>
    </d2p1:IN_Components>
  </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_Components7kRqkrSv>