JiwaAPI

<back to all web services

SH_ApportionedCostsAmountsQuery

Requires Authentication
SH_ApportionedCostsAmountsQuery Parameters:
NameParameterData TypeRequiredDescription
CostsAmountsIDquerystringNo
CostsAmountsIDStartsWithquerystringNo
CostsAmountsIDEndsWithquerystringNo
CostsAmountsIDContainsquerystringNo
CostsAmountsIDLikequerystringNo
CostsAmountsIDBetweenquerystring[]No
CostsAmountsIDInquerystring[]No
ShipmentLineIDquerystringNo
ShipmentLineIDStartsWithquerystringNo
ShipmentLineIDEndsWithquerystringNo
ShipmentLineIDContainsquerystringNo
ShipmentLineIDLikequerystringNo
ShipmentLineIDBetweenquerystring[]No
ShipmentLineIDInquerystring[]No
CostsIDquerystringNo
CostsIDStartsWithquerystringNo
CostsIDEndsWithquerystringNo
CostsIDContainsquerystringNo
CostsIDLikequerystringNo
CostsIDBetweenquerystring[]No
CostsIDInquerystring[]No
Amountquerydecimal?No
AmountGreaterThanOrEqualToquerydecimal?No
AmountGreaterThanquerydecimal?No
AmountLessThanquerydecimal?No
AmountLessThanOrEqualToquerydecimal?No
AmountNotEqualToquerydecimal?No
AmountBetweenqueryNullable<Decimal>[]No
AmountInqueryNullable<Decimal>[]No
IncludeFlagquerybool?No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SH_ApportionedCostsAmounts Parameters:
NameParameterData TypeRequiredDescription
CostsAmountsIDformstringNo
ShipmentLineIDformstringNo
CostsIDformstringNo
Amountformdecimal?No
IncludeFlagformboolNo
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 .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/SH_ApportionedCostsAmountsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CostsAmountsID":"String","CostsAmountsIDStartsWith":"String","CostsAmountsIDEndsWith":"String","CostsAmountsIDContains":"String","CostsAmountsIDLike":"String","CostsAmountsIDBetween":["String"],"CostsAmountsIDIn":["String"],"ShipmentLineID":"String","ShipmentLineIDStartsWith":"String","ShipmentLineIDEndsWith":"String","ShipmentLineIDContains":"String","ShipmentLineIDLike":"String","ShipmentLineIDBetween":["String"],"ShipmentLineIDIn":["String"],"CostsID":"String","CostsIDStartsWith":"String","CostsIDEndsWith":"String","CostsIDContains":"String","CostsIDLike":"String","CostsIDBetween":["String"],"CostsIDIn":["String"],"Amount":0,"AmountGreaterThanOrEqualTo":0,"AmountGreaterThan":0,"AmountLessThan":0,"AmountLessThanOrEqualTo":0,"AmountNotEqualTo":0,"AmountBetween":[0],"AmountIn":[0],"IncludeFlag":false,"RowHash":"AA==","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":[{"CostsAmountsID":"String","ShipmentLineID":"String","CostsID":"String","Amount":0,"RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}