GET api/Product/Get?Clear={Clear}&Changed={Changed}&TargetGroup={TargetGroup}&Indication={Indication}&Category={Category}&Query={Query}&SortOrder={SortOrder}&FsId={FsId}&Brand={Brand}&Limit={Limit}&OffSet={OffSet}&Language={Language}
main method of controller (Get) all allowed parameters from query are parsed in this object
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Clear |
CLEAR ALL FILTERS |
integer |
None. |
Changed |
indicates, which filter initiated Service-Call! |
string |
None. |
TargetGroup |
filter parameter target group |
integer |
None. |
Indication |
filter parameter indication |
integer |
None. |
Category |
filter parameter category/product group |
integer |
None. |
Query |
filter parameter Query |
string |
None. |
SortOrder |
sorting parameter "AZ" or "ZA" |
string |
None. |
FsId |
filter parameter product id TODO: decide whether this is a filter parameter or a separate method call |
integer |
None. |
Brand |
filter parameter brand |
integer |
None. |
FilterByTargetGroup |
determines whether target group filter is set |
boolean |
None. |
FilterByBrand |
determines whether brand filter is set |
boolean |
None. |
FilterByIndication |
determines whether indication filter is set |
boolean |
None. |
FilterByCategory |
determines whether category filter is set |
boolean |
None. |
ClearFilter |
determines whether filter "all/clear" is selected |
boolean |
None. |
FiltersUsed |
indicates whether any filter is set |
boolean |
None. |
Limit |
number of records to be returned |
integer |
None. |
OffSet |
offset; number of objects that are skipped |
integer |
None. |
Language |
Base class for filter parameters; Contains only language as parameter; |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
ExtendedGenericJsonResultName | Description | Type | Additional information |
---|---|---|---|
filter |
filters |
Object |
None. |
count |
number of objects in return data |
integer |
None. |
totalAmountOfResults |
number of total results, not the results returned, especially for SolrSearch |
integer |
None. |
foundMore |
indicates whether there are more result objects than returned |
boolean |
None. |
data |
actual result data |
Object |
None. |
errorMessage |
if an error occured while processing request, this error message is filled string.empty means: no error occured |
string |
None. |
Response Formats
application/json, text/json
{ "filter": {}, "count": 0, "totalAmountOfResults": 2, "foundMore": true, "data": {}, "errorMessage": "sample string 5" }