Find matching names or permit numbers
In addition to the search and retrieval facilities then some simple APIs are provided to assist with UI construction. These take a partial word fragment and return a list of names or registration numbers that contain the fragment. Since these are not retrieval APIs, and not part of the default presentation, they do not support the full range of content negotiation and metadata. They simply return a JSON array of strings containing the available completions.
Query parameters
Partial name of to be matched with permit holder names across all registers. If the infix flag is not given, the response will include only names starting with the query string
Partial registration number of to be matched with registratiosn across all registers. If the infix flag is not given, the response will include only numbers starting with the query string.
Just like with the number-search parameter on other endpoints, search terms ending with a numeral will be treated as exact matches instead of a prefix. Even with the use of infix, a search for BC1 will not return BC123, though it will match ABC1.
If included in the request, the response will include all names or numbers that include the search term as a substring, instead of just those that begin with the search term. Note that no value should be included for this parameter
Response
A list of names or numbers