JiwaAPI

<back to all web services

BM_InputsQuery

Requires Authentication
BM_InputsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
BM_Stages_RecIDquerystringNo
BM_Stages_RecIDStartsWithquerystringNo
BM_Stages_RecIDEndsWithquerystringNo
BM_Stages_RecIDContainsquerystringNo
BM_Stages_RecIDLikequerystringNo
BM_Stages_RecIDBetweenquerystring[]No
BM_Stages_RecIDInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
IsRatioquerybool?No
Quantityquerydecimal?No
QuantityGreaterThanOrEqualToquerydecimal?No
QuantityGreaterThanquerydecimal?No
QuantityLessThanquerydecimal?No
QuantityLessThanOrEqualToquerydecimal?No
QuantityNotEqualToquerydecimal?No
QuantityBetweenquerydecimal[]No
QuantityInquerydecimal[]No
NotequerystringNo
NoteStartsWithquerystringNo
NoteEndsWithquerystringNo
NoteContainsquerystringNo
NoteLikequerystringNo
NoteBetweenquerystring[]No
NoteInquerystring[]No
SubAssemblyquerystringNo
SubAssemblyStartsWithquerystringNo
SubAssemblyEndsWithquerystringNo
SubAssemblyContainsquerystringNo
SubAssemblyLikequerystringNo
SubAssemblyBetweenquerystring[]No
SubAssemblyInquerystring[]No
SubAssemblyExplodePolicyquerybyte?No
SubAssemblyExplodePolicyGreaterThanOrEqualToquerybyte?No
SubAssemblyExplodePolicyGreaterThanquerybyte?No
SubAssemblyExplodePolicyLessThanquerybyte?No
SubAssemblyExplodePolicyLessThanOrEqualToquerybyte?No
SubAssemblyExplodePolicyNotEqualToquerybyte?No
SubAssemblyExplodePolicyBetweenquerybyte[]No
SubAssemblyExplodePolicyInquerybyte[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BM_Inputs Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
BM_Stages_RecIDformstringNo
ItemNoformintNo
InventoryIDformstringNo
IsRatioformboolNo
QuantityformdecimalNo
NoteformstringNo
SubAssemblyformstringNo
SubAssemblyExplodePolicyformbyteNo
RowHashformbyte[]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.

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

<BM_InputsQuery 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>
  <BM_Stages_RecID>String</BM_Stages_RecID>
  <BM_Stages_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_Stages_RecIDBetween>
  <BM_Stages_RecIDContains>String</BM_Stages_RecIDContains>
  <BM_Stages_RecIDEndsWith>String</BM_Stages_RecIDEndsWith>
  <BM_Stages_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_Stages_RecIDIn>
  <BM_Stages_RecIDLike>String</BM_Stages_RecIDLike>
  <BM_Stages_RecIDStartsWith>String</BM_Stages_RecIDStartsWith>
  <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>
  <IsRatio>false</IsRatio>
  <ItemNo>0</ItemNo>
  <ItemNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoBetween>
  <ItemNoGreaterThan>0</ItemNoGreaterThan>
  <ItemNoGreaterThanOrEqualTo>0</ItemNoGreaterThanOrEqualTo>
  <ItemNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoIn>
  <ItemNoLessThan>0</ItemNoLessThan>
  <ItemNoLessThanOrEqualTo>0</ItemNoLessThanOrEqualTo>
  <ItemNoNotEqualTo>0</ItemNoNotEqualTo>
  <Note>String</Note>
  <NoteBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteBetween>
  <NoteContains>String</NoteContains>
  <NoteEndsWith>String</NoteEndsWith>
  <NoteIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteIn>
  <NoteLike>String</NoteLike>
  <NoteStartsWith>String</NoteStartsWith>
  <Quantity>0</Quantity>
  <QuantityBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityBetween>
  <QuantityGreaterThan>0</QuantityGreaterThan>
  <QuantityGreaterThanOrEqualTo>0</QuantityGreaterThanOrEqualTo>
  <QuantityIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityIn>
  <QuantityLessThan>0</QuantityLessThan>
  <QuantityLessThanOrEqualTo>0</QuantityLessThanOrEqualTo>
  <QuantityNotEqualTo>0</QuantityNotEqualTo>
  <RecID>String</RecID>
  <RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDBetween>
  <RecIDContains>String</RecIDContains>
  <RecIDEndsWith>String</RecIDEndsWith>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDIn>
  <RecIDLike>String</RecIDLike>
  <RecIDStartsWith>String</RecIDStartsWith>
  <RowHash>AA==</RowHash>
  <SubAssembly>String</SubAssembly>
  <SubAssemblyBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SubAssemblyBetween>
  <SubAssemblyContains>String</SubAssemblyContains>
  <SubAssemblyEndsWith>String</SubAssemblyEndsWith>
  <SubAssemblyExplodePolicy>0</SubAssemblyExplodePolicy>
  <SubAssemblyExplodePolicyBetween>AA==</SubAssemblyExplodePolicyBetween>
  <SubAssemblyExplodePolicyGreaterThan>0</SubAssemblyExplodePolicyGreaterThan>
  <SubAssemblyExplodePolicyGreaterThanOrEqualTo>0</SubAssemblyExplodePolicyGreaterThanOrEqualTo>
  <SubAssemblyExplodePolicyIn>AA==</SubAssemblyExplodePolicyIn>
  <SubAssemblyExplodePolicyLessThan>0</SubAssemblyExplodePolicyLessThan>
  <SubAssemblyExplodePolicyLessThanOrEqualTo>0</SubAssemblyExplodePolicyLessThanOrEqualTo>
  <SubAssemblyExplodePolicyNotEqualTo>0</SubAssemblyExplodePolicyNotEqualTo>
  <SubAssemblyIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SubAssemblyIn>
  <SubAssemblyLike>String</SubAssemblyLike>
  <SubAssemblyStartsWith>String</SubAssemblyStartsWith>
</BM_InputsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfBM_Inputs7kRqkrSv 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:BM_Inputs>
      <d2p1:_x003C_BM_Stages_RecID_x003E_k__BackingField>String</d2p1:_x003C_BM_Stages_RecID_x003E_k__BackingField>
      <d2p1:_x003C_InventoryID_x003E_k__BackingField>String</d2p1:_x003C_InventoryID_x003E_k__BackingField>
      <d2p1:_x003C_IsRatio_x003E_k__BackingField>false</d2p1:_x003C_IsRatio_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_Note_x003E_k__BackingField>String</d2p1:_x003C_Note_x003E_k__BackingField>
      <d2p1:_x003C_Quantity_x003E_k__BackingField>0</d2p1:_x003C_Quantity_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_SubAssemblyExplodePolicy_x003E_k__BackingField>0</d2p1:_x003C_SubAssemblyExplodePolicy_x003E_k__BackingField>
      <d2p1:_x003C_SubAssembly_x003E_k__BackingField>String</d2p1:_x003C_SubAssembly_x003E_k__BackingField>
    </d2p1:BM_Inputs>
  </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>
</QueryResponseOfBM_Inputs7kRqkrSv>