Skip to main content

Search Template: Extended

For integrating an Atlantis public environment into a third-party site, an endpoint is available to retrieve a search form which can be embedded in the third-party site.

Request

Endpoint: /ExtendedSearchTemplate?groepen={string}&zoekknop-text={string}&leegknop={bool}&leegknop-text={string}

Optional Query-parameters:

  • groepen: A comma-separated list of description-group names. If the groups are missing, we will search through all groups.
  • zoekknop-text: Text shown in the search-button. (default / when parameter is omitted = 'Zoeken').
  • leegknop: if this parameter is given (with any value), a button for resetting the form is presented.
  • leegknop-text: Text shown in the empty-form-button. (default / when parameter is omitted = 'Legen').

Description-groups (Groepen)

The group names can be requested from the application administrators or derived from the public environment. On the search form, there is a section called: 'Zoeken in' / 'Search in', which refers to the group names. These can be used in the request.

Response

As a response, the user will receive an HTML form with the available search options for the requested groups; which will result in the result-page upon submit.

Possible issues

cross-domain-policies

Often, the form will be loaded on sites with the same main domain. If this is not the case, we may need to adjust the cross-domain policies. If desired, DEVENTit can configure this.

global search fields

In the search-field configuration, make sure to add or enable the 'global' fields setting on the desired field.

specific search fields

Only corresponding search-fields within all types of records within the requested group(s) are presented.