SinglePoint

You can use this project to help identify Unique Property Reference Numbers ( UPRN ) using the Idox 'Singlepoint' search API.

https://www.idoxgroup.com/solutions/address-data-solutions/address-search/

Blocks Provided

Provide a list of the blocks provided as part of this integration. This should be a list of block name, and its description.

|Block Name|Purpose| |------------|-------| |Find Address via Singlepoint|The main entry point into this module. This will lookup a property based on first line of address and postcode inputs| |Singlepoint Error|Used whenever there is an error from the API| |Singlepoint No Address Found|Provides a default message to display when the property can not be found. This block doesn't have to be used, it can be changed using the noAddressFound configuration option as provided below.| |Singlepoint Address Found|A placeholder for a successful query. As with the line above, this can be changed using the addressFound property.|

Handler Names

The following handler names and their functions are available :

|Handler Name|Purpose| |------------|-------| |find-uprn|Searches for a UPRN based on the address entered. The result of finding a property will set two variables on the conversation. These are wbb-singlepoint-uprn and wbb-singlepoint-address that will contain the UPRN value, and the full text description of the address.|

Configuration Options

Within the function there are a number of options that can be set to configure the behaviour of the integration. The tables below show the settings that are available for each handler.

find-uprn

|Property|Required|Description| |--------|--------|-----------| |api_key|true|The API key used to authenticate with the service.| |root_url|true|The base URL of the APIs to call. For example, https://webhost.aligned-assets.co.uk/cbeds/WebServices/V2/ | |adapterName|true|The name of the search adapter which will find the properties, ie Sql_LLPG | |firstLine|true|The name of the field containing the first line of address from a form. For example, address1 | |postCode|true|The name of the field containing the postcode for the lookup. For example, postalCode. | |noAddressFound|false|The block ID to use in cases where the input from the user does not result in a property being found. | |addressFound|false|The block ID to use when an address has been found.|