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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/IN_FreightQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FreightInID":"String","FreightInIDStartsWith":"String","FreightInIDEndsWith":"String","FreightInIDContains":"String","FreightInIDLike":"String","FreightInIDBetween":["String"],"FreightInIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"FreightValue":0,"FreightValueGreaterThanOrEqualTo":0,"FreightValueGreaterThan":0,"FreightValueLessThan":0,"FreightValueLessThanOrEqualTo":0,"FreightValueNotEqualTo":0,"FreightValueBetween":[0],"FreightValueIn":[0],"FreightType":0,"FreightTypeGreaterThanOrEqualTo":0,"FreightTypeGreaterThan":0,"FreightTypeLessThan":0,"FreightTypeLessThanOrEqualTo":0,"FreightTypeNotEqualTo":0,"FreightTypeBetween":[0],"FreightTypeIn":[0],"FreightFactor":false,"IsDefault":false,"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"FreightInID":"String","Description":"String","FreightValue":0,"FreightType":0,"FreightFactor":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}