JiwaAPI

<back to all web services

AR_ProviderFiltersQuery

Requires Authentication
AR_ProviderFiltersQuery Parameters:
NameParameterData TypeRequiredDescription
HeaderIDquerystringNo
HeaderIDStartsWithquerystringNo
HeaderIDEndsWithquerystringNo
HeaderIDContainsquerystringNo
HeaderIDLikequerystringNo
HeaderIDBetweenquerystring[]No
HeaderIDInquerystring[]No
FilterIDquerystringNo
FilterIDStartsWithquerystringNo
FilterIDEndsWithquerystringNo
FilterIDContainsquerystringNo
FilterIDLikequerystringNo
FilterIDBetweenquerystring[]No
FilterIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
FilterScriptquerystringNo
FilterScriptStartsWithquerystringNo
FilterScriptEndsWithquerystringNo
FilterScriptContainsquerystringNo
FilterScriptLikequerystringNo
FilterScriptBetweenquerystring[]No
FilterScriptInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
AR_ProviderFilters Parameters:
NameParameterData TypeRequiredDescription
HeaderIDformstringNo
FilterIDformstringNo
DescriptionformstringNo
FilterScriptformstringNo
LastSavedDateTimeformDateTimeNo
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/AR_ProviderFiltersQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"HeaderID":"String","HeaderIDStartsWith":"String","HeaderIDEndsWith":"String","HeaderIDContains":"String","HeaderIDLike":"String","HeaderIDBetween":["String"],"HeaderIDIn":["String"],"FilterID":"String","FilterIDStartsWith":"String","FilterIDEndsWith":"String","FilterIDContains":"String","FilterIDLike":"String","FilterIDBetween":["String"],"FilterIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"FilterScript":"String","FilterScriptStartsWith":"String","FilterScriptEndsWith":"String","FilterScriptContains":"String","FilterScriptLike":"String","FilterScriptBetween":["String"],"FilterScriptIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"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":[{"HeaderID":"String","FilterID":"String","Description":"String","FilterScript":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}