JiwaAPI

<back to all web services

BM_StagesQuery

Requires Authentication
BM_StagesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
BM_Main_RecIDquerystringNo
BM_Main_RecIDStartsWithquerystringNo
BM_Main_RecIDEndsWithquerystringNo
BM_Main_RecIDContainsquerystringNo
BM_Main_RecIDLikequerystringNo
BM_Main_RecIDBetweenquerystring[]No
BM_Main_RecIDInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
BM_ProductionLineWorkCentre_RecIDquerystringNo
BM_ProductionLineWorkCentre_RecIDStartsWithquerystringNo
BM_ProductionLineWorkCentre_RecIDEndsWithquerystringNo
BM_ProductionLineWorkCentre_RecIDContainsquerystringNo
BM_ProductionLineWorkCentre_RecIDLikequerystringNo
BM_ProductionLineWorkCentre_RecIDBetweenquerystring[]No
BM_ProductionLineWorkCentre_RecIDInquerystring[]No
RequiredCapacityquerydecimal?No
RequiredCapacityGreaterThanOrEqualToquerydecimal?No
RequiredCapacityGreaterThanquerydecimal?No
RequiredCapacityLessThanquerydecimal?No
RequiredCapacityLessThanOrEqualToquerydecimal?No
RequiredCapacityNotEqualToquerydecimal?No
RequiredCapacityBetweenqueryNullable<Decimal>[]No
RequiredCapacityInqueryNullable<Decimal>[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BM_Stages Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
BM_Main_RecIDformstringNo
ItemNoformintNo
NameformstringNo
BM_ProductionLineWorkCentre_RecIDformstringNo
RequiredCapacityformdecimal?No
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_StagesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BM_StagesQuery 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_Main_RecID>String</BM_Main_RecID>
  <BM_Main_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_Main_RecIDBetween>
  <BM_Main_RecIDContains>String</BM_Main_RecIDContains>
  <BM_Main_RecIDEndsWith>String</BM_Main_RecIDEndsWith>
  <BM_Main_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_Main_RecIDIn>
  <BM_Main_RecIDLike>String</BM_Main_RecIDLike>
  <BM_Main_RecIDStartsWith>String</BM_Main_RecIDStartsWith>
  <BM_ProductionLineWorkCentre_RecID>String</BM_ProductionLineWorkCentre_RecID>
  <BM_ProductionLineWorkCentre_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_ProductionLineWorkCentre_RecIDBetween>
  <BM_ProductionLineWorkCentre_RecIDContains>String</BM_ProductionLineWorkCentre_RecIDContains>
  <BM_ProductionLineWorkCentre_RecIDEndsWith>String</BM_ProductionLineWorkCentre_RecIDEndsWith>
  <BM_ProductionLineWorkCentre_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_ProductionLineWorkCentre_RecIDIn>
  <BM_ProductionLineWorkCentre_RecIDLike>String</BM_ProductionLineWorkCentre_RecIDLike>
  <BM_ProductionLineWorkCentre_RecIDStartsWith>String</BM_ProductionLineWorkCentre_RecIDStartsWith>
  <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>
  <Name>String</Name>
  <NameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameBetween>
  <NameContains>String</NameContains>
  <NameEndsWith>String</NameEndsWith>
  <NameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameIn>
  <NameLike>String</NameLike>
  <NameStartsWith>String</NameStartsWith>
  <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>
  <RequiredCapacity>0</RequiredCapacity>
  <RequiredCapacityBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </RequiredCapacityBetween>
  <RequiredCapacityGreaterThan>0</RequiredCapacityGreaterThan>
  <RequiredCapacityGreaterThanOrEqualTo>0</RequiredCapacityGreaterThanOrEqualTo>
  <RequiredCapacityIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </RequiredCapacityIn>
  <RequiredCapacityLessThan>0</RequiredCapacityLessThan>
  <RequiredCapacityLessThanOrEqualTo>0</RequiredCapacityLessThanOrEqualTo>
  <RequiredCapacityNotEqualTo>0</RequiredCapacityNotEqualTo>
  <RowHash>AA==</RowHash>
</BM_StagesQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfBM_Stages7kRqkrSv 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_Stages>
      <d2p1:_x003C_BM_Main_RecID_x003E_k__BackingField>String</d2p1:_x003C_BM_Main_RecID_x003E_k__BackingField>
      <d2p1:_x003C_BM_ProductionLineWorkCentre_RecID_x003E_k__BackingField>String</d2p1:_x003C_BM_ProductionLineWorkCentre_RecID_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RequiredCapacity_x003E_k__BackingField>0</d2p1:_x003C_RequiredCapacity_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
    </d2p1:BM_Stages>
  </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_Stages7kRqkrSv>