Search for organisations

The API version number can be supplied as a query parameter.

The text to search for. All searchable fields are searched by default unless searchFields is specified.

When searching searchable fields, the search text itself is tokenized, so multiple terms can be separated by white space, for example search=hello world.

To match any term, use * which can be useful for boolean filter queries. Omitting this parameter has the same effect as setting it to *.

Defaults to any. Specifies whether any or all of the search terms must be matched in order to count the document as a match.

A comma-separated list of field names to search for the specified text. This field works in conjunction with the search field.

Example search field: searchFields=ODSCode

When set to simple, search text is interpreted using a simple query language that allows for symbols such as +, * and "".

When the query type is set to full, search text is interpreted using the Lucene query language which allows field-specific and weighted searches.

The following example is a search over independent terms, with a requirement that all matching documents include pool.

For more information, see Simple query syntax in Azure Cognitive Search.

Example using simple query type:

queryType=simple

search=budget hotel +pool

searchMode=all

This particular example shows in-field search and term boosting. It looks for hotels where the category field contains the term budget.

Any documents containing the phrase recently renovated are ranked higher as a result of the term boost value.

For more information, see Lucene query syntax in Azure Cognitive Search.

Example using full query type:

queryType=full

search=category:budget AND \'recently renovated\'^3

searchMode=all

The number of search results to skip. For example, $skip:25 returns the entries after the first 25 entries in the search results.

The number of search results to retrieve. The default is 50.

Optional, defaults to false. Specifies whether to fetch the total count of results.

This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip.

Setting this value to true may have a performance impact. The count returned is an approximation.

If you’d like to get only the count without any documents, you can use $top=0.

A list of comma-separated expressions to sort the results by. Each expression can be either a field name or a call to the geo.distance() function.

Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

This $orderBy routine orders the results by the distance from the geography point included in the expression.

The geography point can be a position from where you are and the results are ordered by how local the results are.

For more information, see Simple query syntax in Azure Cognitive Search.

Example: $orderby=geo.distance(Geocode, geography'POINT(-0.76444095373153675 52.000820159912109)')

A list of comma-separated fields to include in the result set.

If unspecified or set to *, all fields marked as retrievable in the schema are included in the projection.

Example: $select=ODSCode,OrganisationName,Contacts,Address1,Address2,Address3,City,Postcode,OrganisationSubType

A structured search expression in standard OData syntax.

The $filter parameter specifies inclusion or exclusion criteria for returning matches in search results.

For more information on using the $filter, see OData $filter syntax in Azure Cognitive Search.

Examples:

Filter results by Pharmacies that are EPS-enabled and classed as 'Community', that is, IsEpsEnabled is true, Organisation Type is PHA and Sub Type is Community:

$filter=IsEpsEnabled eq 'true' and OrganisationTypeId eq 'PHA' and OrganisationSubType eq 'Community'

Filter results that match our postcode, that is Postcode field is NG16:

$filter=search.ismatch('NG16', 'Postcode')

Filter results by Postcode is CW9 and `OrganisationTypeId" is a dentist:

$filter=search.ismatch('CW9', 'Postcode') and OrganisationTypeId eq 'DEN'

For details on organisation types and service codes, see organisation and service codes.