JiwaAPI

<back to all web services

SO_HistoryFreightItemsQuery

Requires Authentication
SO_HistoryFreightItemsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
SO_History_InvoiceHistoryIDquerystringNo
SO_History_InvoiceHistoryIDStartsWithquerystringNo
SO_History_InvoiceHistoryIDEndsWithquerystringNo
SO_History_InvoiceHistoryIDContainsquerystringNo
SO_History_InvoiceHistoryIDLikequerystringNo
SO_History_InvoiceHistoryIDBetweenquerystring[]No
SO_History_InvoiceHistoryIDInquerystring[]No
FR_CarrierFreightDescriptions_RecIDquerystringNo
FR_CarrierFreightDescriptions_RecIDStartsWithquerystringNo
FR_CarrierFreightDescriptions_RecIDEndsWithquerystringNo
FR_CarrierFreightDescriptions_RecIDContainsquerystringNo
FR_CarrierFreightDescriptions_RecIDLikequerystringNo
FR_CarrierFreightDescriptions_RecIDBetweenquerystring[]No
FR_CarrierFreightDescriptions_RecIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
NumberItemsquerydecimal?No
NumberItemsGreaterThanOrEqualToquerydecimal?No
NumberItemsGreaterThanquerydecimal?No
NumberItemsLessThanquerydecimal?No
NumberItemsLessThanOrEqualToquerydecimal?No
NumberItemsNotEqualToquerydecimal?No
NumberItemsBetweenquerydecimal[]No
NumberItemsInquerydecimal[]No
ItemWeightquerydecimal?No
ItemWeightGreaterThanOrEqualToquerydecimal?No
ItemWeightGreaterThanquerydecimal?No
ItemWeightLessThanquerydecimal?No
ItemWeightLessThanOrEqualToquerydecimal?No
ItemWeightNotEqualToquerydecimal?No
ItemWeightBetweenquerydecimal[]No
ItemWeightInquerydecimal[]No
ItemCubicquerydecimal?No
ItemCubicGreaterThanOrEqualToquerydecimal?No
ItemCubicGreaterThanquerydecimal?No
ItemCubicLessThanquerydecimal?No
ItemCubicLessThanOrEqualToquerydecimal?No
ItemCubicNotEqualToquerydecimal?No
ItemCubicBetweenquerydecimal[]No
ItemCubicInquerydecimal[]No
ItemLengthquerydecimal?No
ItemLengthGreaterThanOrEqualToquerydecimal?No
ItemLengthGreaterThanquerydecimal?No
ItemLengthLessThanquerydecimal?No
ItemLengthLessThanOrEqualToquerydecimal?No
ItemLengthNotEqualToquerydecimal?No
ItemLengthBetweenquerydecimal[]No
ItemLengthInquerydecimal[]No
ItemWidthquerydecimal?No
ItemWidthGreaterThanOrEqualToquerydecimal?No
ItemWidthGreaterThanquerydecimal?No
ItemWidthLessThanquerydecimal?No
ItemWidthLessThanOrEqualToquerydecimal?No
ItemWidthNotEqualToquerydecimal?No
ItemWidthBetweenquerydecimal[]No
ItemWidthInquerydecimal[]No
ItemHeightquerydecimal?No
ItemHeightGreaterThanOrEqualToquerydecimal?No
ItemHeightGreaterThanquerydecimal?No
ItemHeightLessThanquerydecimal?No
ItemHeightLessThanOrEqualToquerydecimal?No
ItemHeightNotEqualToquerydecimal?No
ItemHeightBetweenquerydecimal[]No
ItemHeightInquerydecimal[]No
SO_HistoryConsignmentNotes_RecIDquerystringNo
SO_HistoryConsignmentNotes_RecIDStartsWithquerystringNo
SO_HistoryConsignmentNotes_RecIDEndsWithquerystringNo
SO_HistoryConsignmentNotes_RecIDContainsquerystringNo
SO_HistoryConsignmentNotes_RecIDLikequerystringNo
SO_HistoryConsignmentNotes_RecIDBetweenquerystring[]No
SO_HistoryConsignmentNotes_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_HistoryFreightItems Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
ReferenceformstringNo
SO_History_InvoiceHistoryIDformstringNo
FR_CarrierFreightDescriptions_RecIDformstringNo
LastSavedDateTimeformDateTimeNo
NumberItemsformdecimalNo
ItemWeightformdecimalNo
ItemCubicformdecimalNo
ItemLengthformdecimalNo
ItemWidthformdecimalNo
ItemHeightformdecimalNo
SO_HistoryConsignmentNotes_RecIDformstringNo
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/SO_HistoryFreightItemsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SO_HistoryFreightItemsQuery 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>
  <FR_CarrierFreightDescriptions_RecID>String</FR_CarrierFreightDescriptions_RecID>
  <FR_CarrierFreightDescriptions_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FR_CarrierFreightDescriptions_RecIDBetween>
  <FR_CarrierFreightDescriptions_RecIDContains>String</FR_CarrierFreightDescriptions_RecIDContains>
  <FR_CarrierFreightDescriptions_RecIDEndsWith>String</FR_CarrierFreightDescriptions_RecIDEndsWith>
  <FR_CarrierFreightDescriptions_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FR_CarrierFreightDescriptions_RecIDIn>
  <FR_CarrierFreightDescriptions_RecIDLike>String</FR_CarrierFreightDescriptions_RecIDLike>
  <FR_CarrierFreightDescriptions_RecIDStartsWith>String</FR_CarrierFreightDescriptions_RecIDStartsWith>
  <ItemCubic>0</ItemCubic>
  <ItemCubicBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemCubicBetween>
  <ItemCubicGreaterThan>0</ItemCubicGreaterThan>
  <ItemCubicGreaterThanOrEqualTo>0</ItemCubicGreaterThanOrEqualTo>
  <ItemCubicIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemCubicIn>
  <ItemCubicLessThan>0</ItemCubicLessThan>
  <ItemCubicLessThanOrEqualTo>0</ItemCubicLessThanOrEqualTo>
  <ItemCubicNotEqualTo>0</ItemCubicNotEqualTo>
  <ItemHeight>0</ItemHeight>
  <ItemHeightBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemHeightBetween>
  <ItemHeightGreaterThan>0</ItemHeightGreaterThan>
  <ItemHeightGreaterThanOrEqualTo>0</ItemHeightGreaterThanOrEqualTo>
  <ItemHeightIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemHeightIn>
  <ItemHeightLessThan>0</ItemHeightLessThan>
  <ItemHeightLessThanOrEqualTo>0</ItemHeightLessThanOrEqualTo>
  <ItemHeightNotEqualTo>0</ItemHeightNotEqualTo>
  <ItemLength>0</ItemLength>
  <ItemLengthBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemLengthBetween>
  <ItemLengthGreaterThan>0</ItemLengthGreaterThan>
  <ItemLengthGreaterThanOrEqualTo>0</ItemLengthGreaterThanOrEqualTo>
  <ItemLengthIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemLengthIn>
  <ItemLengthLessThan>0</ItemLengthLessThan>
  <ItemLengthLessThanOrEqualTo>0</ItemLengthLessThanOrEqualTo>
  <ItemLengthNotEqualTo>0</ItemLengthNotEqualTo>
  <ItemWeight>0</ItemWeight>
  <ItemWeightBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemWeightBetween>
  <ItemWeightGreaterThan>0</ItemWeightGreaterThan>
  <ItemWeightGreaterThanOrEqualTo>0</ItemWeightGreaterThanOrEqualTo>
  <ItemWeightIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemWeightIn>
  <ItemWeightLessThan>0</ItemWeightLessThan>
  <ItemWeightLessThanOrEqualTo>0</ItemWeightLessThanOrEqualTo>
  <ItemWeightNotEqualTo>0</ItemWeightNotEqualTo>
  <ItemWidth>0</ItemWidth>
  <ItemWidthBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemWidthBetween>
  <ItemWidthGreaterThan>0</ItemWidthGreaterThan>
  <ItemWidthGreaterThanOrEqualTo>0</ItemWidthGreaterThanOrEqualTo>
  <ItemWidthIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemWidthIn>
  <ItemWidthLessThan>0</ItemWidthLessThan>
  <ItemWidthLessThanOrEqualTo>0</ItemWidthLessThanOrEqualTo>
  <ItemWidthNotEqualTo>0</ItemWidthNotEqualTo>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <NumberItems>0</NumberItems>
  <NumberItemsBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </NumberItemsBetween>
  <NumberItemsGreaterThan>0</NumberItemsGreaterThan>
  <NumberItemsGreaterThanOrEqualTo>0</NumberItemsGreaterThanOrEqualTo>
  <NumberItemsIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </NumberItemsIn>
  <NumberItemsLessThan>0</NumberItemsLessThan>
  <NumberItemsLessThanOrEqualTo>0</NumberItemsLessThanOrEqualTo>
  <NumberItemsNotEqualTo>0</NumberItemsNotEqualTo>
  <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>
  <Reference>String</Reference>
  <ReferenceBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ReferenceBetween>
  <ReferenceContains>String</ReferenceContains>
  <ReferenceEndsWith>String</ReferenceEndsWith>
  <ReferenceIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ReferenceIn>
  <ReferenceLike>String</ReferenceLike>
  <ReferenceStartsWith>String</ReferenceStartsWith>
  <SO_HistoryConsignmentNotes_RecID>String</SO_HistoryConsignmentNotes_RecID>
  <SO_HistoryConsignmentNotes_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SO_HistoryConsignmentNotes_RecIDBetween>
  <SO_HistoryConsignmentNotes_RecIDContains>String</SO_HistoryConsignmentNotes_RecIDContains>
  <SO_HistoryConsignmentNotes_RecIDEndsWith>String</SO_HistoryConsignmentNotes_RecIDEndsWith>
  <SO_HistoryConsignmentNotes_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SO_HistoryConsignmentNotes_RecIDIn>
  <SO_HistoryConsignmentNotes_RecIDLike>String</SO_HistoryConsignmentNotes_RecIDLike>
  <SO_HistoryConsignmentNotes_RecIDStartsWith>String</SO_HistoryConsignmentNotes_RecIDStartsWith>
  <SO_History_InvoiceHistoryID>String</SO_History_InvoiceHistoryID>
  <SO_History_InvoiceHistoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SO_History_InvoiceHistoryIDBetween>
  <SO_History_InvoiceHistoryIDContains>String</SO_History_InvoiceHistoryIDContains>
  <SO_History_InvoiceHistoryIDEndsWith>String</SO_History_InvoiceHistoryIDEndsWith>
  <SO_History_InvoiceHistoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SO_History_InvoiceHistoryIDIn>
  <SO_History_InvoiceHistoryIDLike>String</SO_History_InvoiceHistoryIDLike>
  <SO_History_InvoiceHistoryIDStartsWith>String</SO_History_InvoiceHistoryIDStartsWith>
</SO_HistoryFreightItemsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSO_HistoryFreightItems7kRqkrSv 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:SO_HistoryFreightItems>
      <d2p1:_x003C_FR_CarrierFreightDescriptions_RecID_x003E_k__BackingField>String</d2p1:_x003C_FR_CarrierFreightDescriptions_RecID_x003E_k__BackingField>
      <d2p1:_x003C_ItemCubic_x003E_k__BackingField>0</d2p1:_x003C_ItemCubic_x003E_k__BackingField>
      <d2p1:_x003C_ItemHeight_x003E_k__BackingField>0</d2p1:_x003C_ItemHeight_x003E_k__BackingField>
      <d2p1:_x003C_ItemLength_x003E_k__BackingField>0</d2p1:_x003C_ItemLength_x003E_k__BackingField>
      <d2p1:_x003C_ItemWeight_x003E_k__BackingField>0</d2p1:_x003C_ItemWeight_x003E_k__BackingField>
      <d2p1:_x003C_ItemWidth_x003E_k__BackingField>0</d2p1:_x003C_ItemWidth_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_NumberItems_x003E_k__BackingField>0</d2p1:_x003C_NumberItems_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_Reference_x003E_k__BackingField>String</d2p1:_x003C_Reference_x003E_k__BackingField>
      <d2p1:_x003C_SO_HistoryConsignmentNotes_RecID_x003E_k__BackingField>String</d2p1:_x003C_SO_HistoryConsignmentNotes_RecID_x003E_k__BackingField>
      <d2p1:_x003C_SO_History_InvoiceHistoryID_x003E_k__BackingField>String</d2p1:_x003C_SO_History_InvoiceHistoryID_x003E_k__BackingField>
    </d2p1:SO_HistoryFreightItems>
  </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>
</QueryResponseOfSO_HistoryFreightItems7kRqkrSv>