Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LinkID | query | string | No | |
LinkIDStartsWith | query | string | No | |
LinkIDEndsWith | query | string | No | |
LinkIDContains | query | string | No | |
LinkIDLike | query | string | No | |
LinkIDBetween | query | string[] | No | |
LinkIDIn | query | string[] | No | |
PriceID | query | string | No | |
PriceIDStartsWith | query | string | No | |
PriceIDEndsWith | query | string | No | |
PriceIDContains | query | string | No | |
PriceIDLike | query | string | No | |
PriceIDBetween | query | string[] | No | |
PriceIDIn | query | string[] | No | |
InventoryID | query | string | No | |
InventoryIDStartsWith | query | string | No | |
InventoryIDEndsWith | query | string | No | |
InventoryIDContains | query | string | No | |
InventoryIDLike | query | string | No | |
InventoryIDBetween | query | string[] | No | |
InventoryIDIn | query | string[] | No | |
Price | query | decimal? | No | |
PriceGreaterThanOrEqualTo | query | decimal? | No | |
PriceGreaterThan | query | decimal? | No | |
PriceLessThan | query | decimal? | No | |
PriceLessThanOrEqualTo | query | decimal? | No | |
PriceNotEqualTo | query | decimal? | No | |
PriceBetween | query | Nullable<Decimal>[] | No | |
PriceIn | query | Nullable<Decimal>[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LinkID | form | string | No | |
PriceID | form | string | No | |
InventoryID | form | string | No | |
Price | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/IN_PriceLinkQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"LinkID":"String","LinkIDStartsWith":"String","LinkIDEndsWith":"String","LinkIDContains":"String","LinkIDLike":"String","LinkIDBetween":["String"],"LinkIDIn":["String"],"PriceID":"String","PriceIDStartsWith":"String","PriceIDEndsWith":"String","PriceIDContains":"String","PriceIDLike":"String","PriceIDBetween":["String"],"PriceIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"Price":0,"PriceGreaterThanOrEqualTo":0,"PriceGreaterThan":0,"PriceLessThan":0,"PriceLessThanOrEqualTo":0,"PriceNotEqualTo":0,"PriceBetween":[0],"PriceIn":[0],"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":[{"LinkID":"String","PriceID":"String","InventoryID":"String","Price":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}