Ordnance Survey

Last updated 1 year ago

Was this helpful?

Ordnance Survey

There is full integration with the Ordnance Survey's Places API for the applicant to find their address. They simply need to enter a postcode to locate their street and then select from the list provided:

Plus, in order to ensure that applications that are made relate only to properties within the boundary of the council, there is the ability to limit the search results to that of your council.

Simply let us know whether you want it to be limited to your council area or not during implementation.

Address Lookup Style

There is a setting that controls the style of the address look up. The setting is:

AddressLookupStyle

The two modes available which needs you to set them as the value for the above setting.

TypeAheadSearch (this is the default)

If this option is enabled, as the user types in an address or postcode, it will instantly start searching for addresses. This provides a smart way of dynamically getting the results as the user enters their address.

The speed of the API can mean that sometimes it takes a while for the results to refresh and so if you find this, we'd suggest using the 'Postcode' method.

Postcode

If this option is selected the customer needs to enter a postcode and then physically click a search button.

We'd recommend using this method.

Notes

If the setting is not present, you simply need to use the Create button at the bottom of the Form Management > Settings page to add it and set its value to your preferred style.

This can be added at either form level or at global level (not form specific) in your form settings.

Prerequisite

In early 2021, Councils became able to use the Ordnance Survey APIs to search for addresses at no cost.

These APIs are documented here:

In order that this can be set up by the IEG4 team, we need to have the council's API key for this. This is free to councils now and simply needs you to create an account per below:

Once you have this simply provide the details to IEG4 support:

PreviousIntegrations NextOpenProcess

Last updated 1 year ago

Was this helpful?

Plus, in order to ensure that applications that are made relate only to properties within the boundary of the council, there is the ability to limit the search results to that of your council.

Simply let us know whether you want it to be limited to your council area or not during implementation.

Address Lookup Style

There is a setting that controls the style of the address look up. The setting is:

AddressLookupStyle

The two modes available which needs you to set them as the value for the above setting.

TypeAheadSearch (this is the default)

The speed of the API can mean that sometimes it takes a while for the results to refresh and so if you find this, we'd suggest using the 'Postcode' method.

Postcode

If this option is selected the customer needs to enter a postcode and then physically click a search button.

We'd recommend using this method.

Notes

If the setting is not present, you simply need to use the Create button at the bottom of the Form Management > Settings page to add it and set its value to your preferred style.

This can be added at either form level or at global level (not form specific) in your form settings.

Prerequisite

In early 2021, Councils became able to use the Ordnance Survey APIs to search for addresses at no cost.

These APIs are documented here:

In order that this can be set up by the IEG4 team, we need to have the council's API key for this. This is free to councils now and simply needs you to create an account per below:

If you are a Public Sector Geospatial Agreement (PSGA) member you can access and use the OS Places API (excluding Match & Cleanse) for free via the OS DataHub. Register for an account or login at

Once you have this simply provide the details to IEG4 support:

Please use this link to raise any new support calls:

And this link is to access details about previous support calls you have raised: (you may be required to Register as a new user, which is simple and quick to do)