JiwaAPI

<back to all web services

IN_PriceQuery

Requires Authentication
IN_PriceQuery Parameters:
NameParameterData TypeRequiredDescription
PriceIDquerystringNo
PriceIDStartsWithquerystringNo
PriceIDEndsWithquerystringNo
PriceIDContainsquerystringNo
PriceIDLikequerystringNo
PriceIDBetweenquerystring[]No
PriceIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
QuantityBreakquerydecimal?No
QuantityBreakGreaterThanOrEqualToquerydecimal?No
QuantityBreakGreaterThanquerydecimal?No
QuantityBreakLessThanquerydecimal?No
QuantityBreakLessThanOrEqualToquerydecimal?No
QuantityBreakNotEqualToquerydecimal?No
QuantityBreakBetweenqueryNullable<Decimal>[]No
QuantityBreakInqueryNullable<Decimal>[]No
ExpiryDatequeryDateTime?No
ExpiryDateGreaterThanOrEqualToqueryDateTime?No
ExpiryDateGreaterThanqueryDateTime?No
ExpiryDateLessThanqueryDateTime?No
ExpiryDateLessThanOrEqualToqueryDateTime?No
ExpiryDateNotEqualToqueryDateTime?No
ExpiryDateBetweenqueryNullable<DateTime>[]No
ExpiryDateInqueryNullable<DateTime>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Price Parameters:
NameParameterData TypeRequiredDescription
PriceIDformstringNo
LastSavedDateTimeformDateTime?No
DescriptionformstringNo
QuantityBreakformdecimal?No
ExpiryDateformDateTime?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/IN_PriceQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"PriceID":"String","PriceIDStartsWith":"String","PriceIDEndsWith":"String","PriceIDContains":"String","PriceIDLike":"String","PriceIDBetween":["String"],"PriceIDIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"QuantityBreak":0,"QuantityBreakGreaterThanOrEqualTo":0,"QuantityBreakGreaterThan":0,"QuantityBreakLessThan":0,"QuantityBreakLessThanOrEqualTo":0,"QuantityBreakNotEqualTo":0,"QuantityBreakBetween":[0],"QuantityBreakIn":[0],"ExpiryDate":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateNotEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateBetween":["0001-01-01T00:00:00.0000000"],"ExpiryDateIn":["0001-01-01T00:00:00.0000000"],"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":[{"PriceID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Description":"String","QuantityBreak":0,"ExpiryDate":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}