JiwaAPI

<back to all web services

IN_FreightQuery

Requires Authentication
IN_FreightQuery Parameters:
NameParameterData TypeRequiredDescription
FreightInIDquerystringNo
FreightInIDStartsWithquerystringNo
FreightInIDEndsWithquerystringNo
FreightInIDContainsquerystringNo
FreightInIDLikequerystringNo
FreightInIDBetweenquerystring[]No
FreightInIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
FreightValuequerydecimal?No
FreightValueGreaterThanOrEqualToquerydecimal?No
FreightValueGreaterThanquerydecimal?No
FreightValueLessThanquerydecimal?No
FreightValueLessThanOrEqualToquerydecimal?No
FreightValueNotEqualToquerydecimal?No
FreightValueBetweenqueryNullable<Decimal>[]No
FreightValueInqueryNullable<Decimal>[]No
FreightTypequeryshort?No
FreightTypeGreaterThanOrEqualToqueryshort?No
FreightTypeGreaterThanqueryshort?No
FreightTypeLessThanqueryshort?No
FreightTypeLessThanOrEqualToqueryshort?No
FreightTypeNotEqualToqueryshort?No
FreightTypeBetweenqueryNullable<Int16>[]No
FreightTypeInqueryNullable<Int16>[]No
FreightFactorquerybool?No
IsDefaultquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Freight Parameters:
NameParameterData TypeRequiredDescription
FreightInIDformstringNo
DescriptionformstringNo
FreightValueformdecimal?No
FreightTypeformshort?No
FreightFactorformbool?No
IsDefaultformboolNo
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_FreightQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IN_FreightQuery 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>
  <Description>String</Description>
  <DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionBetween>
  <DescriptionContains>String</DescriptionContains>
  <DescriptionEndsWith>String</DescriptionEndsWith>
  <DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionIn>
  <DescriptionLike>String</DescriptionLike>
  <DescriptionStartsWith>String</DescriptionStartsWith>
  <FreightFactor>false</FreightFactor>
  <FreightInID>String</FreightInID>
  <FreightInIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FreightInIDBetween>
  <FreightInIDContains>String</FreightInIDContains>
  <FreightInIDEndsWith>String</FreightInIDEndsWith>
  <FreightInIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FreightInIDIn>
  <FreightInIDLike>String</FreightInIDLike>
  <FreightInIDStartsWith>String</FreightInIDStartsWith>
  <FreightType>0</FreightType>
  <FreightTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </FreightTypeBetween>
  <FreightTypeGreaterThan>0</FreightTypeGreaterThan>
  <FreightTypeGreaterThanOrEqualTo>0</FreightTypeGreaterThanOrEqualTo>
  <FreightTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </FreightTypeIn>
  <FreightTypeLessThan>0</FreightTypeLessThan>
  <FreightTypeLessThanOrEqualTo>0</FreightTypeLessThanOrEqualTo>
  <FreightTypeNotEqualTo>0</FreightTypeNotEqualTo>
  <FreightValue>0</FreightValue>
  <FreightValueBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </FreightValueBetween>
  <FreightValueGreaterThan>0</FreightValueGreaterThan>
  <FreightValueGreaterThanOrEqualTo>0</FreightValueGreaterThanOrEqualTo>
  <FreightValueIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </FreightValueIn>
  <FreightValueLessThan>0</FreightValueLessThan>
  <FreightValueLessThanOrEqualTo>0</FreightValueLessThanOrEqualTo>
  <FreightValueNotEqualTo>0</FreightValueNotEqualTo>
  <IsDefault>false</IsDefault>
</IN_FreightQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfIN_Freight7kRqkrSv 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_Freight>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_FreightFactor_x003E_k__BackingField>false</d2p1:_x003C_FreightFactor_x003E_k__BackingField>
      <d2p1:_x003C_FreightInID_x003E_k__BackingField>String</d2p1:_x003C_FreightInID_x003E_k__BackingField>
      <d2p1:_x003C_FreightType_x003E_k__BackingField>0</d2p1:_x003C_FreightType_x003E_k__BackingField>
      <d2p1:_x003C_FreightValue_x003E_k__BackingField>0</d2p1:_x003C_FreightValue_x003E_k__BackingField>
      <d2p1:_x003C_IsDefault_x003E_k__BackingField>false</d2p1:_x003C_IsDefault_x003E_k__BackingField>
    </d2p1:IN_Freight>
  </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_Freight7kRqkrSv>