GET api/Search/Get?Query={Query}&Limit={Limit}&OffSet={OffSet}&Language={Language}
endpoint; main method of controller (Get) all allowed parameters (query, limit, offset, language) from query are parsed in this object
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Query |
query parameter for searching; |
string |
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
standard result object; data = search results
GenericJsonResultName | Description | Type | Additional information |
---|---|---|---|
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
{ "count": 0, "totalAmountOfResults": 1, "foundMore": true, "data": {}, "errorMessage": "sample string 4" }