JiwaAPI

SY_FiltersQuery

**SY_FiltersQuery** Parameters:
Name	Parameter	Data Type	Required
RecID	query	string	No
RecIDStartsWith	query	string	No
RecIDEndsWith	query	string	No
RecIDContains	query	string	No
RecIDLike	query	string	No
RecIDBetween	query	string[]	No
RecIDIn	query	string[]	No
FilterNo	query	int?	No
FilterNoGreaterThanOrEqualTo	query	int?	No
FilterNoGreaterThan	query	int?	No
FilterNoLessThan	query	int?	No
FilterNoLessThanOrEqualTo	query	int?	No
FilterNoNotEqualTo	query	int?	No
FilterNoBetween	query	int[]	No
FilterNoIn	query	int[]	No
FilterString	query	string	No
FilterStringStartsWith	query	string	No
FilterStringEndsWith	query	string	No
FilterStringContains	query	string	No
FilterStringLike	query	string	No
FilterStringBetween	query	string[]	No
FilterStringIn	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
ItemNo	query	int?	No
ItemNoGreaterThanOrEqualTo	query	int?	No
ItemNoGreaterThan	query	int?	No
ItemNoLessThan	query	int?	No
ItemNoLessThanOrEqualTo	query	int?	No
ItemNoNotEqualTo	query	int?	No
ItemNoBetween	query	int[]	No
ItemNoIn	query	int[]	No
Name	query	string	No
NameStartsWith	query	string	No
NameEndsWith	query	string	No
NameContains	query	string	No
NameLike	query	string	No
NameBetween	query	string[]	No
NameIn	query	string[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
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

**SY_Filters** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
FilterNo	form	int	No
FilterString	form	string	No
Description	form	string	No
ItemNo	form	int	No
Name	form	string	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/SY_FiltersQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"FilterNo":0,"FilterNoGreaterThanOrEqualTo":0,"FilterNoGreaterThan":0,"FilterNoLessThan":0,"FilterNoLessThanOrEqualTo":0,"FilterNoNotEqualTo":0,"FilterNoBetween":[0],"FilterNoIn":[0],"FilterString":"String","FilterStringStartsWith":"String","FilterStringEndsWith":"String","FilterStringContains":"String","FilterStringLike":"String","FilterStringBetween":["String"],"FilterStringIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["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":[{"RecID":"String","FilterString":"String","Description":"String","Name":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}