CodBiOpenPLZQueryAction

This servlet acts as a nano server to pass request from a form using the CodBi along with the OpenPLZ REST API (checkout the documentation for further information about the header-parameter). Unlike the REST-Service returning paginated results, this servlet accumulates all available data and returns it as a single block.

Configuration Keys:

• OpenPLZ_URL: The URL of the endpoint to use.

• OpenPLZ_UpdateCycle: The number of hours to wait until a request causes a fresh REST-Request.

Header:

• country: The country-code of the country to fetch the data of.

• orgaUnit: The organisational unit to fetch (e.g. /de/ FederalStates). This may be FederalStates, FederalProvinces or Cantons.

• officialKey The optional key (number) of a state, province or canton to get details from.

• detail: The optional detail to fetch about a certain state, province or canton identified by the officialKey (not optional if an official key is present). May be Municipalities, or Districts.

• param1 There may be up to four parameter passed along the request (e.g. postalCode, name, locality, searchTerm).

• param2 There may be up to four parameter passed along the request (e.g. postalCode, name, locality, searchTerm).

• param3 There may be up to four parameter passed along the request (e.g. postalCode, name, locality, searchTerm).

• param4 There may be up to four parameter passed along the request (e.g. postalCode, name, locality, searchTerm).