Performing global lookups

Flow showing how to perform a global search

Get the search criteria

You can enter multiple terms with or without categories to search the global data. When you include multiple terms in the search, the records that match more of the terms are prioritised. The search is case insensitive and spaces cannot be included within the terms.

You specify the categories that are searched by including the category attribute. For example to search the address fields for Ashton-Under-Lyne, enter <ns:SearchTerm category="address">Ashton-Under-Lyne</ns:SearchTerm>. If you do not specify a category all fields are searched.

Note

The available categories are bic, bank, address and country and must be all in lower-case.

Get the BIC

To look up the details for a BIC, supply the BIC (11 or 8 digit) or part of a BIC with a wildcard. If using the 8 digit BIC, you must set the category to bic.

Call GlobalSearch

To perform the search, call the GlobalSearch service supplying:

the search criteria, made up of one or more search terms and categories
page - which page of results you want to retrieve
pageSize - the number of results you want retrieved
header details - reportString and itemisationId.

Get the response

To find out the result of the search, you need to retrieve the search response. This always shows whether a new search token has been generated and the size of the results.

If the search was successful, it also includes an array of the results and a search token.

Are there any errors?

Errors are returned if you have not supplied the correct data within the search request. If you receive any errors, you should re-prompt for the missing or incorrect information and then call the search service again.

Has a new search token been returned?

If NewToken is set to true, this search has generated a new search token. You should cache this so that you can use it to retrieve any further pages of results for this search.

Display the results

Depending on your business requirements, you could display a summary or all of the branch information returned for each match.

Note

You should never display the search token to the user.

Are there any more results?

Depending on your page size and the number of matches, you may need to call the service again to retrieve the remaining matches. To do this, increment the pageNumber, then set the category to token and supply the search token instead of the search term.

For example:<ns:SearchTerm category="token">Qw3420e45r...</ns:SearchTerm>