bcgov / bcgov/ols-geocoder

Add support for an alias address in a geocoding request for autocompletion

Open
#8 1 comment 0 reactions 0 assignees View on GitHub
api enhancement geocoder medium priority
Dominant language
Java
Stars
17
Forks
7
Avg merge
10h 2m
Merged PRs (30d)
15

Description

An alias address is an address that includes the alias street and/or locality as entered. This is returned only if autoComplete=True.

In autocompletion mode, an application tries to autocomplete an address as a user is typing. If they start typing an alias locality as in:

4460 Happy Valley Rd, saan

the following fullAddress is among the top five choices:

4460 Happy Valley Rd, Metchosin, BC

but the following aliasAddress is not among them:

4460 Happy Valley Rd, Saanich, BC

This is confusing to a user because they can't select the full address they are trying to enter. To overcome this, add an aliasAddress property in the addresses response. aliasAddress should be set to null or not included in the response if no alias was detected in the input. Otherwise, aliasAddress should be set to the complete fullAddress using the aliases entered. fullAddress should alway contain the correct, official address.

This issue was first reported by Elections BC.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.