JiwaAPI

SO_HistoryCarrierQuery

**SO_HistoryCarrierQuery** Parameters:
Name	Parameter	Data Type	Required
SO_History_InvoiceHistoryID	query	string	No
SO_History_InvoiceHistoryIDStartsWith	query	string	No
SO_History_InvoiceHistoryIDEndsWith	query	string	No
SO_History_InvoiceHistoryIDContains	query	string	No
SO_History_InvoiceHistoryIDLike	query	string	No
SO_History_InvoiceHistoryIDBetween	query	string[]	No
SO_History_InvoiceHistoryIDIn	query	string[]	No
UseLeastCost	query	bool?	No
FR_Carriers_RecID	query	string	No
FR_Carriers_RecIDStartsWith	query	string	No
FR_Carriers_RecIDEndsWith	query	string	No
FR_Carriers_RecIDContains	query	string	No
FR_Carriers_RecIDLike	query	string	No
FR_Carriers_RecIDBetween	query	string[]	No
FR_Carriers_RecIDIn	query	string[]	No
FR_CarrierServices_RecID	query	string	No
FR_CarrierServices_RecIDStartsWith	query	string	No
FR_CarrierServices_RecIDEndsWith	query	string	No
FR_CarrierServices_RecIDContains	query	string	No
FR_CarrierServices_RecIDLike	query	string	No
FR_CarrierServices_RecIDBetween	query	string[]	No
FR_CarrierServices_RecIDIn	query	string[]	No
FreightSystemStatus	query	byte?	No
FreightSystemStatusGreaterThanOrEqualTo	query	byte?	No
FreightSystemStatusGreaterThan	query	byte?	No
FreightSystemStatusLessThan	query	byte?	No
FreightSystemStatusLessThanOrEqualTo	query	byte?	No
FreightSystemStatusNotEqualTo	query	byte?	No
FreightSystemStatusBetween	query	byte[]	No
FreightSystemStatusIn	query	byte[]	No
ChargeTo	query	byte?	No
ChargeToGreaterThanOrEqualTo	query	byte?	No
ChargeToGreaterThan	query	byte?	No
ChargeToLessThan	query	byte?	No
ChargeToLessThanOrEqualTo	query	byte?	No
ChargeToNotEqualTo	query	byte?	No
ChargeToBetween	query	byte[]	No
ChargeToIn	query	byte[]	No
CarrierAccountNo	query	string	No
CarrierAccountNoStartsWith	query	string	No
CarrierAccountNoEndsWith	query	string	No
CarrierAccountNoContains	query	string	No
CarrierAccountNoLike	query	string	No
CarrierAccountNoBetween	query	string[]	No
CarrierAccountNoIn	query	string[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**SO_HistoryCarrier** Parameters:
Name	Parameter	Data Type	Required
SO_History_InvoiceHistoryID	form	string	No
UseLeastCost	form	bool?	No
FR_Carriers_RecID	form	string	No
FR_CarrierServices_RecID	form	string	No
FreightSystemStatus	form	byte	No
ChargeTo	form	byte	No
CarrierAccountNo	form	string	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

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_HistoryCarrierQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SO_HistoryCarrierQuery 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>
  <CarrierAccountNo>String</CarrierAccountNo>
  <CarrierAccountNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CarrierAccountNoBetween>
  <CarrierAccountNoContains>String</CarrierAccountNoContains>
  <CarrierAccountNoEndsWith>String</CarrierAccountNoEndsWith>
  <CarrierAccountNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CarrierAccountNoIn>
  <CarrierAccountNoLike>String</CarrierAccountNoLike>
  <CarrierAccountNoStartsWith>String</CarrierAccountNoStartsWith>
  <ChargeTo>0</ChargeTo>
  <ChargeToBetween>AA==</ChargeToBetween>
  <ChargeToGreaterThan>0</ChargeToGreaterThan>
  <ChargeToGreaterThanOrEqualTo>0</ChargeToGreaterThanOrEqualTo>
  <ChargeToIn>AA==</ChargeToIn>
  <ChargeToLessThan>0</ChargeToLessThan>
  <ChargeToLessThanOrEqualTo>0</ChargeToLessThanOrEqualTo>
  <ChargeToNotEqualTo>0</ChargeToNotEqualTo>
  <FR_CarrierServices_RecID>String</FR_CarrierServices_RecID>
  <FR_CarrierServices_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FR_CarrierServices_RecIDBetween>
  <FR_CarrierServices_RecIDContains>String</FR_CarrierServices_RecIDContains>
  <FR_CarrierServices_RecIDEndsWith>String</FR_CarrierServices_RecIDEndsWith>
  <FR_CarrierServices_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FR_CarrierServices_RecIDIn>
  <FR_CarrierServices_RecIDLike>String</FR_CarrierServices_RecIDLike>
  <FR_CarrierServices_RecIDStartsWith>String</FR_CarrierServices_RecIDStartsWith>
  <FR_Carriers_RecID>String</FR_Carriers_RecID>
  <FR_Carriers_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FR_Carriers_RecIDBetween>
  <FR_Carriers_RecIDContains>String</FR_Carriers_RecIDContains>
  <FR_Carriers_RecIDEndsWith>String</FR_Carriers_RecIDEndsWith>
  <FR_Carriers_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FR_Carriers_RecIDIn>
  <FR_Carriers_RecIDLike>String</FR_Carriers_RecIDLike>
  <FR_Carriers_RecIDStartsWith>String</FR_Carriers_RecIDStartsWith>
  <FreightSystemStatus>0</FreightSystemStatus>
  <FreightSystemStatusBetween>AA==</FreightSystemStatusBetween>
  <FreightSystemStatusGreaterThan>0</FreightSystemStatusGreaterThan>
  <FreightSystemStatusGreaterThanOrEqualTo>0</FreightSystemStatusGreaterThanOrEqualTo>
  <FreightSystemStatusIn>AA==</FreightSystemStatusIn>
  <FreightSystemStatusLessThan>0</FreightSystemStatusLessThan>
  <FreightSystemStatusLessThanOrEqualTo>0</FreightSystemStatusLessThanOrEqualTo>
  <FreightSystemStatusNotEqualTo>0</FreightSystemStatusNotEqualTo>
  <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>
  <UseLeastCost>false</UseLeastCost>
</SO_HistoryCarrierQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSO_HistoryCarrier7kRqkrSv 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_HistoryCarrier>
      <d2p1:_x003C_CarrierAccountNo_x003E_k__BackingField>String</d2p1:_x003C_CarrierAccountNo_x003E_k__BackingField>
      <d2p1:_x003C_ChargeTo_x003E_k__BackingField>0</d2p1:_x003C_ChargeTo_x003E_k__BackingField>
      <d2p1:_x003C_FR_CarrierServices_RecID_x003E_k__BackingField>String</d2p1:_x003C_FR_CarrierServices_RecID_x003E_k__BackingField>
      <d2p1:_x003C_FR_Carriers_RecID_x003E_k__BackingField>String</d2p1:_x003C_FR_Carriers_RecID_x003E_k__BackingField>
      <d2p1:_x003C_FreightSystemStatus_x003E_k__BackingField>0</d2p1:_x003C_FreightSystemStatus_x003E_k__BackingField>
      <d2p1:_x003C_SO_History_InvoiceHistoryID_x003E_k__BackingField>String</d2p1:_x003C_SO_History_InvoiceHistoryID_x003E_k__BackingField>
      <d2p1:_x003C_UseLeastCost_x003E_k__BackingField>false</d2p1:_x003C_UseLeastCost_x003E_k__BackingField>
    </d2p1:SO_HistoryCarrier>
  </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_HistoryCarrier7kRqkrSv>