JiwaAPI

<back to all web services

VLogicalWHQuery

Requires Authentication
VLogicalWHQuery Parameters:
NameParameterData TypeRequiredDescription
LogicalWHquerystringNo
LogicalWHStartsWithquerystringNo
LogicalWHEndsWithquerystringNo
LogicalWHContainsquerystringNo
LogicalWHLikequerystringNo
LogicalWHBetweenquerystring[]No
LogicalWHInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
VLogicalWH Parameters:
NameParameterData TypeRequiredDescription
LogicalWHformstringNo
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/VLogicalWHQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"LogicalWH":"String","LogicalWHStartsWith":"String","LogicalWHEndsWith":"String","LogicalWHContains":"String","LogicalWHLike":"String","LogicalWHBetween":["String"],"LogicalWHIn":["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":[{"LogicalWH":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}