GET api/ZipSearch/Get?Clear={Clear}&Changed={Changed}&Zip={Zip}&Region={Region}&RegionId={RegionId}&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.

Zip

filter parameter Zip Search

string

None.

Region

filter parameter Region Search

string

None.

RegionId

filter parameter Region Search by Code

string

None.

FilterByZip

Tag for Filter by Zip

boolean

None.

FilterByRegion

Tag for Filter by Region

boolean

None.

FilterByRegionId

Tag for Filter by RegionCode

boolean

None.

ClearFilter

determines whether filter "all/clear" is selected

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"
}