Skip to main content

Global Search Result

For integrating an Atlantis public environment into a third-party site, an endpoint is available to retrieve a search result count and html-form based on given description-groups and search-term.

Request​

Endpoint: /GlobalSearchResult?term={string}&groepen={string}

Query-parameters:

  • term: The search term used for 'global' searching. If the value is empty, we will search using the wildcard '*'.
  • groepen: A comma-separated list of description-group names. If the groups are missing, we will search through all groups.

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 the total number of found items and an HTML form that allows redirection to the public environment (result page).

{
  "total" : "string",
  "html-form" : "string"
}
  • total: The total number of results when searching with the term within the groups. This can be used by the website builder to present the total number of results in the searched groups.
  • html-form: The HTML form with pre-filled data based on the term and groups. The form contains hidden fields, allowing the website builder to display a button that users can click on.

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.