GET api/Download/GetData
Endpoint for Download-Filter results
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
DocumentType |
filter parameter document type |
Collection of integer |
None. |
FilterType |
filter that indicates whether Step 2 is triggered by Brand and Product-DropDowns or ProductName-(Autocomplete)-Textfield |
string |
None. |
Brand |
filter parameter brand |
integer |
None. |
Products |
filter parameter product-ID (- should be mapped to name "products") TECHNICAL ID! |
integer |
None. |
ProductName |
filter parameter name (should be mapped to name "filter-text") |
string |
None. |
FilterByDocumentType |
determines whether document type filter is set |
boolean |
None. |
FilterByBrand |
determines whether brand filter is set |
boolean |
None. |
FilterByProductName |
determines whether product filter (by name) is set |
boolean |
None. |
FilterByProduct |
determines whether product filter is set, careful: works not as usual => step2-decision has to be considered |
boolean |
None. |
FilterByProductId |
determines whether product filter (by id) is set and considers step 2 decision |
boolean |
None. |
Step2FilterUsesDropdowns |
determines whether dropdowns are active at "step2" |
boolean |
None. |
Step2FilterUsesTextfield |
determines whether dropdowns are active at "step2" |
boolean |
None. |
Language |
Base class for filter parameters; Contains only language as parameter; |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Download 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" }