ExecuteQASearch service

You use this service to search for an address. Typically this returns a pick list that contains matching addresses and the percentage score assigned to the match.

To search for an address you need to supply:

Country - the country of the address, typically this is GBR
Engine - the search engine to use (SingleLine, Typedown, Verification or Keyfinder) and the settings for that engine. This is case sensitive

You can specify whether the search is flattened, the intensity of the search (Exact, Close or Extensive), the prompt set to apply, and the timeout period

Search - the string for which you want to search.

Optionally, you can also supply a layout to specify the format to use for the returned address.

The Identity Hub User Interface uses the SingleLine engine with a flattened search and the experian layout. The following XML shows how to specify this configuration:

<qas:Engine Flatten="true">Singleline</qas:Engine>
<qas:Layout>experian</qas:Layout>

This service returns a QASPicklistEntry group for each address that matches the entered search string. The QASPicklistEntry group includes:

Moniker - this is a unique reference for the matched address and is used by the ExecuteQAGetAddress service
PartialAddress - this is the partial address
Picklist - this is the information to display in a list for the user to select the required address
Postcode - the postcode for the matching address
Score - a score to show how well this entry matched the entered search details.

SOAP messages

Request

<soapenv:Body>

<ns:ExecuteQASearch>

<eih:EIHHeader>

<eih:ClientUser>user</eih:ClientUser>

<eih:ReferenceId>123</eih:ReferenceId>

</eih:EIHHeader>

<qas:QASearch Language="">

<qas:Country>GBR</qas:Country>

<qas:Engine Flatten="true">Singleline</qas:Engine>

<qas:Layout>experian</qas:Layout>

<qas:Search>LL55 4YF</qas:Search>

</qas:QASearch>

</ns:ExecuteQASearch>

</soapenv:Body>

Response

<SOAP-ENV:Body>

<eih:QASearchResult>

<header:EIHHeader>

<header:ClientUser>user</header:ClientUser>

<header:ReferenceId>123</header:ReferenceId>

</header:EIHHeader>

<qas:QAPicklist>

<qas:PicklistEntry>

<qas:Moniker>0wOGBREgPbBwAAAAABAwEAAAAAgKtvAAAAAAAAZAAAAAD.....AAAAAAAAAAAA</qas:Moniker>

<qas:PartialAddress>Aber Cottage, Beddgelert, CAERNARFON, Gwynedd LL55 4YF</qas:PartialAddress>

<qas:Picklist>Aber Cottage, Beddgelert, CAERNARFON, Gwynedd</qas:Picklist>

<qas:Postcode>LL55 4YF</qas:Postcode>

<qas:Score>100</qas:Score>

</qas:PicklistEntry>

<qas:PicklistEntry>

<qas:Moniker>0DOGBREgPbBwAAAAABAwEAAAAAgKtxAAAAAAAAZAAAAAD.....AAAAAAAAAAAA</qas:Moniker>

<qas:PartialAddress>Aberglaslyn Hall, Beddgelert, CAERNARFON, Gwynedd LL55 4YF</qas:PartialAddress>

<qas:Picklist>Aberglaslyn Hall, Beddgelert, CAERNARFON, Gwynedd</qas:Picklist>

<qas:Postcode>LL55 4YF</qas:Postcode>

<qas:Score>100</qas:Score>

</qas:PicklistEntry>

...

<qas:PicklistEntry>

<qas:Moniker>08OGBREgPbBwAAAAABAwEAAAAAgKuFgAAAAAAAZAAAAAD.....AAAAAAAAAAAA</qas:Moniker>

<qas:PartialAddress>Turnpike Cottage, Beddgelert, CAERNARFON, Gwynedd LL55 4YF</qas:PartialAddress>

<qas:Picklist>Turnpike Cottage, Beddgelert, CAERNARFON, Gwynedd</qas:Picklist>

<qas:Postcode>LL55 4YF</qas:Postcode>

<qas:Score>100</qas:Score>

</qas:PicklistEntry>

</qas:QAPicklist>

</eih:QASearchResult>

</SOAP-ENV:Body>