| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 | |
| SerialNo | query | string | No | |
| SerialNoStartsWith | query | string | No | |
| SerialNoEndsWith | query | string | No | |
| SerialNoContains | query | string | No | |
| SerialNoLike | query | string | No | |
| SerialNoBetween | query | string[] | No | |
| SerialNoIn | query | string[] | No | |
| PartNo | query | string | No | |
| PartNoStartsWith | query | string | No | |
| PartNoEndsWith | query | string | No | |
| PartNoContains | query | string | No | |
| PartNoLike | query | string | No | |
| PartNoBetween | query | string[] | No | |
| PartNoIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | 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 |
|---|---|---|---|---|
| inventoryid | form | string | No | |
| SerialNo | form | string | No | |
| PartNo | form | string | No | |
| Description | form | string | 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/v_SerialNumbersSoldQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"inventoryid":"String","inventoryidStartsWith":"String","inventoryidEndsWith":"String","inventoryidContains":"String","inventoryidLike":"String","inventoryidBetween":["String"],"inventoryidIn":["String"],"SerialNo":"String","SerialNoStartsWith":"String","SerialNoEndsWith":"String","SerialNoContains":"String","SerialNoLike":"String","SerialNoBetween":["String"],"SerialNoIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"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":[{"inventoryid":"String","SerialNo":"String","PartNo":"String","Description":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}