JiwaAPI

<back to all web services

SY_FiltersQuery

Requires Authentication
SY_FiltersQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
FilterNoqueryint?No
FilterNoGreaterThanOrEqualToqueryint?No
FilterNoGreaterThanqueryint?No
FilterNoLessThanqueryint?No
FilterNoLessThanOrEqualToqueryint?No
FilterNoNotEqualToqueryint?No
FilterNoBetweenqueryint[]No
FilterNoInqueryint[]No
FilterStringquerystringNo
FilterStringStartsWithquerystringNo
FilterStringEndsWithquerystringNo
FilterStringContainsquerystringNo
FilterStringLikequerystringNo
FilterStringBetweenquerystring[]No
FilterStringInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_Filters Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
FilterNoformintNo
FilterStringformstringNo
DescriptionformstringNo
ItemNoformintNo
NameformstringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/SY_FiltersQuery HTTP/1.1 
Host: localhost 
Accept: application/json
Content-Type: application/json
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: application/json
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"}}}