GET api/Blog/Get?Clear={Clear}&Changed={Changed}&BlogCategory={BlogCategory}&BlogTag={BlogTag}&BlogAuthor={BlogAuthor}&SkipBlog={SkipBlog}&FsId={FsId}&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

NameDescriptionTypeAdditional information
Clear

CLEAR ALL FILTERS

integer

None.

Changed

indicates, which filter initiated Service-Call!

string

None.

BlogCategory

filter parameter blogcategory group

integer

None.

BlogTag

filter parameter blogcategory/tag group

string

None.

BlogAuthor

filter parameter Author group

integer

None.

SkipBlog

filter parameter skip Blog Entry

integer

None.

FsId

filter parameter product id TODO: decide whether this is a filter parameter or a separate method call

integer

None.

FilterByBlogcategory

determines whether category filter is set

boolean

None.

FilterByAuthor

determines whether Author filter is set

boolean

None.

FilterByTag

determines whether Tag filter is set

boolean

None.

FilterSkipBlog

determines whether Tag 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

ExtendedGenericJsonResult
NameDescriptionTypeAdditional 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

Sample:
{
  "filter": {},
  "count": 0,
  "totalAmountOfResults": 2,
  "foundMore": true,
  "data": {},
  "errorMessage": "sample string 5"
}