JiwaAPI

<back to all web services

IN_PriceSchemesQuery

Requires Authentication
IN_PriceSchemesQuery Parameters:
NameParameterData TypeRequiredDescription
PriceSchemeIDquerystringNo
PriceSchemeIDStartsWithquerystringNo
PriceSchemeIDEndsWithquerystringNo
PriceSchemeIDContainsquerystringNo
PriceSchemeIDLikequerystringNo
PriceSchemeIDBetweenquerystring[]No
PriceSchemeIDInquerystring[]No
PriceSchemeDescriptionquerystringNo
PriceSchemeDescriptionStartsWithquerystringNo
PriceSchemeDescriptionEndsWithquerystringNo
PriceSchemeDescriptionContainsquerystringNo
PriceSchemeDescriptionLikequerystringNo
PriceSchemeDescriptionBetweenquerystring[]No
PriceSchemeDescriptionInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
SchemeActivequerybool?No
FindTheCheapestquerybool?No
IsDefaultquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_PriceSchemes Parameters:
NameParameterData TypeRequiredDescription
PriceSchemeIDformstringNo
PriceSchemeDescriptionformstringNo
LastSavedDateTimeformDateTimeNo
SchemeActiveformboolNo
FindTheCheapestformboolNo
IsDefaultformbool?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_PriceSchemesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"PriceSchemeID":"String","PriceSchemeIDStartsWith":"String","PriceSchemeIDEndsWith":"String","PriceSchemeIDContains":"String","PriceSchemeIDLike":"String","PriceSchemeIDBetween":["String"],"PriceSchemeIDIn":["String"],"PriceSchemeDescription":"String","PriceSchemeDescriptionStartsWith":"String","PriceSchemeDescriptionEndsWith":"String","PriceSchemeDescriptionContains":"String","PriceSchemeDescriptionLike":"String","PriceSchemeDescriptionBetween":["String"],"PriceSchemeDescriptionIn":["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"],"SchemeActive":false,"FindTheCheapest":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":[{"PriceSchemeID":"String","PriceSchemeDescription":"String","IsDefault":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}