JiwaAPI

<back to all web services

AR_ProviderQuery

Requires Authentication
AR_ProviderQuery Parameters:
NameParameterData TypeRequiredDescription
ProviderIDquerystringNo
ProviderIDStartsWithquerystringNo
ProviderIDEndsWithquerystringNo
ProviderIDContainsquerystringNo
ProviderIDLikequerystringNo
ProviderIDBetweenquerystring[]No
ProviderIDInquerystring[]No
ProviderNamequerystringNo
ProviderNameStartsWithquerystringNo
ProviderNameEndsWithquerystringNo
ProviderNameContainsquerystringNo
ProviderNameLikequerystringNo
ProviderNameBetweenquerystring[]No
ProviderNameInquerystring[]No
StoredProcedureNamequerystringNo
StoredProcedureNameStartsWithquerystringNo
StoredProcedureNameEndsWithquerystringNo
StoredProcedureNameContainsquerystringNo
StoredProcedureNameLikequerystringNo
StoredProcedureNameBetweenquerystring[]No
StoredProcedureNameInquerystring[]No
ProviderDescriptionquerystringNo
ProviderDescriptionStartsWithquerystringNo
ProviderDescriptionEndsWithquerystringNo
ProviderDescriptionContainsquerystringNo
ProviderDescriptionLikequerystringNo
ProviderDescriptionBetweenquerystring[]No
ProviderDescriptionInquerystring[]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_Provider Parameters:
NameParameterData TypeRequiredDescription
ProviderIDformstringNo
ProviderNameformstringNo
StoredProcedureNameformstringNo
ProviderDescriptionformstringNo
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_ProviderQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ProviderID":"String","ProviderIDStartsWith":"String","ProviderIDEndsWith":"String","ProviderIDContains":"String","ProviderIDLike":"String","ProviderIDBetween":["String"],"ProviderIDIn":["String"],"ProviderName":"String","ProviderNameStartsWith":"String","ProviderNameEndsWith":"String","ProviderNameContains":"String","ProviderNameLike":"String","ProviderNameBetween":["String"],"ProviderNameIn":["String"],"StoredProcedureName":"String","StoredProcedureNameStartsWith":"String","StoredProcedureNameEndsWith":"String","StoredProcedureNameContains":"String","StoredProcedureNameLike":"String","StoredProcedureNameBetween":["String"],"StoredProcedureNameIn":["String"],"ProviderDescription":"String","ProviderDescriptionStartsWith":"String","ProviderDescriptionEndsWith":"String","ProviderDescriptionContains":"String","ProviderDescriptionLike":"String","ProviderDescriptionBetween":["String"],"ProviderDescriptionIn":["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":[{"ProviderID":"String","ProviderName":"String","StoredProcedureName":"String","ProviderDescription":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}