Skip to content

glossary

leo edited this page May 11, 2017 · 1 revision

Geocoder Glossary of Terms

Term Definition
accessNotes Contains additional information that is helpful in determining the access location and any restrictions on mode of access (e.g., boat only, floatplane only).
accessPoint A point that lies on the curb or road edge of the site's assigned street and in the middle of a site’s driveway or access lane. If a site has no driveway or access lane, the accessPoint will be located in the middle of the entrance walkway.
accessPointRetireDate The date the access point was retired.
accessPointStatus The status of the access point (active, or retired). A civic access point is usually only Retired if the associated site is renumbered, destroyed, or combined with another site. A non-civic access point is usually retired when its associated site is assigned a civic number or the site becomes unoccupied.
Adaptive Address Interpolation The process of inferring the location of a site with a given civic number using a road centreline, an address range, and other known site locations for a given block face. Adaptive interpolation uses the ratio (civicNumber - precedingKnownCivicNumber) / (followingKnownCivicNumber - precedingKnownCivicNumber) and the locations of the preceding, known civic number and the following, known civic number.
addressString Civic address or intersection address as a single string in Single-line Address Format. If not present in an address request, individual address elements, such as streetName, localityName, and provinceCode must be provided.
In an occupant/addresses resource, addressString represents an Occupant name followed by a frontGate delimiter ('--') followed by an optional address.
Address match Conveys site address match quality through score, precision, and faults properties. faults is a data type that defines a list of faults. Each fault contains the nature of the fault, the address property affected, and the fault penalty. precisionPoints defines the points assigned to each match precision level. MatchPrecision is an enumeration of all precision levels. MatchFaultPenalty defines the penalty value of each possible fault. Penalties are subtracted from the appropriate precision level points to arrive at a score.
blockID The unique, immutable identifier of a road segment in the Integrated Transportation Network that a matched address is located on.
bbox A rectangular geographic area used to filter results of a query. Coordinates are specified as xmin,ymin,xmax,ymax . By default, coordinates are longitude minimum, latitude minimum, longitude maximum, latitude maximum in the default output SRS, 4326 (WGS84).
businessCategoryClass NAICS name of category class associated with occupant.
businessCategoryDescription Description of NAICS Category associated with occupant.
centre The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search area. centre and maxDistance together define a search area.
changeDate The date a site address or intersection address was last changed.
Civic Address The address of a site as assigned by an addressing authority such as a municipality. A civic address includes a civicNumber, civicNumberSuffix, and the localityName is that assigned by the address authority, not Canada Post. Here are some examples:
840 Esquimalt Rd, Esquimalt, BC
2317 MOODY AVE Kamloops, BC
Apt 1 -- 1207 Douglas St, Victoria, BC
525 Superior St, Victoria,BC
4251A Rockbank Pl, West Vancouver, BC
4450 Happy Valley Rd, Metchosin, BC
Unit 110 -- 408 East Kent Ave S, Vancouver, BC
2050 SW Marine Dr,Vancouver,BC
420 Gorge Rd E, Victoria, BC
130A Hall St,Nelson,BC
Unit 1 -- 7467 Aspen Blvd, Pemberton, BC
Pad 2, 2097 Wildflower Rd,Shawnigan Lake, BC
Port Alice Health Centre -- 1090 Marine Dr, Port Alice, BC
Royal Athletic Park -- 1014 Caledonia Ave, Victoria,BC
civicNumber The number assigned to a site on a street by an address authority (e.g., the 1175 in 1175 Douglas St, Victoria, BC).
civicNumberSuffix A letter or fraction that follows the civic number. There should be no space between a civic number and a letter (e.g., Unit 1A) and one space between a civic number and a fraction (e.g., Suite 3 1/2)
contactEmail Contact email address of occupant
contactFax Contact fax number of occupant
contactPhone Contact phone number of occupant
custodianId Unique id assigned to custodian of occupant data.
dateOccupantUpdated The date the occupant was last updated in the Geographic Site Registry.
dateOccupantAdded The date the occupant was added to the Geographic Site Registry.
degree The number of road segments that intersection at an intersection. The degree of a dead-end is 1. The degree of a 4-way intersection is 4.
echo Include unmatched address details such as site name in results.
endDate The ending date of a time period formatted as YYYY-MM-DD .
executionTime Query execution time in milliseconds
extrapolate If true, uses supplied parcelPoint to derive an appropriate accessPoint. If extrapolate=true and no parcelPoint is provided or if extrapolate= false and a parcelPoint is provided, no extrapolation is performed and locationDescriptor is used to determine type of point to return.
faults A list of faults the geocoder found with a given address match. Each fault contains the nature of the fault, the address element affected, and the fault penalty. Here is the complete list of faults .
frontDoorPoint A point representing the position of the front door or main entrance to a house or building.
fullAddress The cleaned, standardized, and validated address of a site or intersection as a single string in Single-line Address Format.
fullSiteDescriptor That portion of fullAddress that precedes the civic number (in the case of a civic address) or the localityName (in the case of a non-civic address). Here is an example:
RM 104, Student Union Building -- University of Victoria
geomark A point, line, or polygon of interest that can be shared in a variety of formats and map projections. Geomarks are created by the Geomark Service.
geomarkURL The URL of a polygon geomark that should be used by the geocoder as a bounding box in the /bgeo/sites/within query. Point and line geomarks will not work. When specifying this URL programmatically, it should be url-encoded without format and projection parameters.
imageUrl URL of an occupant's photo or picture
Interpolated Site A site whose civic number is assumed to be valid because it lies within a known address range and whose location was interpolated using the address range (e.g., linear address interpolation) or the address range plus the locations of known sites (e.g., adaptive address interpolation).
interpolation In the case of a block level match, the method of interpolation to determine how far down the block the accessPoint should be. The geocoder supports linear and adaptive interpolation.
Intersection A dead-end or the intersection of two or more roads.
intersectionID A unique and immutable identifier assigned to a given intersection in the Integrated Transportation Network.
Intersection Address The intersection of two or more named streets as a single string. Here are some examples:
Douglas St and Gorge Rd E and Hillside Ave, Victoria, BC
48th Ave W and Marine Dr SW, Vancouver, BC
intersectionName The street name, type, direction, and qualifier of all streets that meet at a given intersection. Here are some examples:
Douglas St and Gorge Rd E and Hillside Ave
48th Ave W and Marine Dr SW
isOfficial True if official accessPoint of the associated site.
keywords semi-colon delimited list of keywords associated with occupant
Linear Address Interpolation The process of inferring the location of a site with a given civic number using a road centreline and address range for a given block face. Linear interpolation uses the ratio (civicNumber - blockFaceMinCivicNumber) / (blockFaceMaxCivicNumber - blockFaceMinCivicNumber) and the locations of the beginning and end of the block.
localityName The name of the locality assigned to a given site by an address authority such as a municipality, Regional District, Indian Reserve, First Nations government, or the Department of National Defense. It may also be an official name of a natural feature from the BC Geographical Names Information System (BCGNIS). A locality name that starts with a directional is not abbreviated (e.g., North Vancouver, not N Vancouver). Spelling of localities that are place names or natural feature names MUST match that published by BCGNIS.
localityType The type of address authority that assigned the localityName to the address.
location The coordinate pair of the matched location in the requested projection.
locationPositionalAccuracy The positional accuracy of the location of a site as follows:
high – observed or measured using GPS or survey instruments, or digitized off imagery with a resolution of 1m or better
medium – derived from parcel boundaries or from a point known to be inside a parcel that contains the site
low – interpolated along a block face address range
Coarse – position represents an entire street, locality, or province
locationDescriptor Describes the nature of the address location. Values include accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, and routingPoint. As an input parameter, a value of any is allowed. When any is specified, a point type other than accessPoint will be returned if one is defined; otherwise, an accessPoint will be returned.
Main Location A geometric point representing the rooftop, front door, or centre of the property.
matchFaultPenalty Defines the penalty value of each possible fault. Penalties are subtracted from the appropriate precision level points to arrive at a match score.
matchPrecision The level of precision of an address match. Here are the nine levels from the most precise to least precise:
OCCUPANT – the site occupant name matched
SITE – the site name matched
UNIT – the unit number, unit number suffix, and unit designator matched
CIVIC_NUMBER – the civic number matched
INTERSECTION – the intersection matched
BLOCK – the civic number falls within a known block range
STREET – the street name, street direction, and street type matched
LOCALITY – the locality matched
PROVINCE - no match
When used as an input parameter, matchPrecision is a comma-separated list of matchPrecision levels. Only matches with a matchPrecision in this list will be included in the request results. For example, matchPrecision=STREET will only include street-level matches.
matchPrecisionNot A comma-separated list of matchPrecision levels to exclude from request results. For example, &matchPrecisionNot=UNIT,SITE will exclude matches at the unit and site levels.
maxDistance The maximum distance (in metres) to search from the given point. If not specified, the maximum distance is unlimited.
maxResults Maximum number of matched addresses to return for each input address. The default is 1.
minDegree Minimum degree an intersection can have to be included in results. A dead-end has a degree of 1. The default is 2.
maxDegree The maximum degree an intersection can have to be included in results. A four-way stop has a degree of 4. The default is 100.
minScore The minimum score an address match must have before it is included in the results. Scores range between 0 and 100 inclusive. The default is 0.
naicsCode NAICS code assigned to occupant. For more information, see NAICS Canada
narrativeLocation Turn-by-turn directions to the site from a named location on the Integrated Transportion Network as in the following:
From Tlell, travel north on Highway 16 till you see a big golden spruce tree on your left, hike west for about one kilometre.
Non-civic Address An address that has no civicNumber. It must have a siteName, localityName, and provinceCode. It may also have street elements (e.g., streetName, streetType), a narrative location, and accessNotes. Landmarks and remote industrial sites typically have non-civic addresses.
Occupant An occupant is a business, government office, public facility, landmark, named natural feature, or named infrastructure that occupies a given site address. The occupant may be permanent or seasonal but not transient (e.g., not a booth at an event). Examples are:
Terrace Hearing Clinic Ltd, 4550 Lakelse Ave, Terrace, BC
Victoria General Hospital, 1 Hospital Way, Victoria, BC
W.A.C. Bennett Dam, Hudson's Hope, BC
105 km Post, HWY 97 S, Kersley, BC
Thetis Lake, Langford, BC
occupantAliasAddress Address for display purposes. Useful when you want an occupant to display a recognizable localityName instead of the municipally-correct one (e.g., Brentwood Bay instead Central Saanich).
occupantDescription Occupant description
occupantID Unique id assigned to occupant
occupantName Name of occupant
outputFormat Format of request results. Allowed values are xhtml, kml, csv, shpz, geojson, geojsonp, gml
outputSRS The EPSG code of the spatial reference system used to state the coordination location of a named feature. It is ignored if KML output is specified since KML only supports 4326 (WGS84). Allowed values are:
3005: BC Albers
4326: WGS 84 (default)
26907-26911: NAD83/UTM Zones 7N through 11N
32607-32611: WGS84/UTM Zones 7N through 11N
26707-26711: NAD27/UTM Zones 7N through 11N
parcelPoint A point representing a position known to be within the boundaries of a land parcel, usually the parcel centroid.
point The coordinates of the centre of a circle whose radius is defined by maxDistance. Together, centre and maxDistance define a search area. Format is x,y where x and y are coordinates in the specified outputSRS projection. By default, x is longitude and y is latitude in the default outputSRS projection of 4326 (WGS84).
precisionPoints Defines the points assigned to each match precision level.
provinceCode The ISO 3166-2 Sub-Country Code for British Columbia, which is BC.
rooftopPoint A point representing the roof of a house or building.
routingPoint A point lying on a road centreline and directly in front of a site's accessPoint. A routing point is intended for use by routing algorithms to finding routes between addresses.
score A number between 0 and 100 representing the quality of an address match; 100 is a perfect match; 0 means no match. Score is computed by taking the precision points and subtracting penalty points for each fault found.
searchTimestamp Date/time search was completed (in format yyyy-mm-dd hh:mm:ss.sss)
setBack The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored on input if locationDescriptor not set to accessPoint.
site A constructed geographic feature in British Columbia with known coordinates (latitude/longitude) and a site address that is needed in the conduct of provincial business. Examples of constructed geographic features include houses, cabins, permanent campsites, mobile home and RV parks, units within houses and buildings, buildings within complexes, stores, malls, offices, industrial plants, bandshell, golf courses, hospitals, universities, recreation centres, places of worship, parks, municipal pumping stations, hydro sub-stations, wharves, airports, train stations, and landmarks.
Site Address A civic address or non-civic address associated with a given site.
siteID A unique identifier assigned to every site in B.C. They are currently not immutable. matchPrecision levels other than unit, site, and civicNumber don’t return a siteID.
siteName A string containing the name of a site (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird House). A business name should only be used if it is permanently affixed to the site and the site has no other, more generic name. If a site is a unit within a complex, it may have a sitename in addition to a unitNumber and unitNumberSuffix.
siteRetireDate The date a site was retired.
siteStatus A site is usually retired when it is destroyed or combined with another site. Allowed values are active or retired.
sourceDataId Id assigned to an occupant by its data custodian. custodianId plus sourcDataId is unique within geocoder.
spatialReferenceSystem The EPSG code of the spatial reference system used to state the coordination location of a named feature. It is ignored if KML output is specified since KML only supports 4326 (WGS84). Allowed values are:
3005: BC Albers
4326: WGS 84 (default)
26907-26911: NAD83/UTM Zones 7N through 11N
32607-32611: WGS84/UTM Zones 7N through 11N
26707-26711: NAD27/UTM Zones 7N through 11N
startDate The starting date of a time period formatted as YYYY-MM-DD
Street Centreline A line that is parallel to the street edges and located in the middle of the roadway. A street centreline exists even on streets that have no painted lines on them (e.g., a residential or unpaved street). A street centreline is oriented in the direction of increasing civic numbers. In the case of blocks that have continuous numbering that goes up on one side and down the other the street centreline is oriented in the direction of the lowest block range.
streetDirection The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities . The complete list is C, E, N, NE, NO, NW, O, SE, SO, SW, and W. All street directions except C are defined by Canada Post. On input, the French streetDirections NO, O, and SO are mapped to NW, W, and SW respectively.
streetName The official name of the street recognized by a municipality (e.g., Douglas in 1175 Douglas Street). Sometimes, its difficult to determine if a directional is part of a street name or not. For example, given the address 1640 East Kent Ave S, Vancouver, BC, is East part of the street name or a streetDirection? Given there is already a street Direction of "S" after the street type, East is likely part of the street name. A trickier example is North Park St. Is the word "North" a street direction or a part of the street name. Because it is not abbreviated, "North" is probably part of the street name. The street name in N Park St could be either Park or North Park.
streetType The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS ST) and is abbreviated if such an abbreviation exists. On input, French streetTypes are mapped to their English counterpart (e.g., Rue => St). The set of all street types is defined by the provincial Integration Transportation Network program.
streetQualifier The qualifier of a street as assigned by a municipality (e.g., the Bridge in Johnson St Bridge). The set of all street qualifiers is defined by the provincial Integrated Transportion Network program. Here are some more qualifiers:
350, 420, Airport, Airstrip, Arm, Bay, Beach, Boardwalk, Boatlaunch, Brakecheck, Campground, Causeway, Chainoff, Chainup, Channel, Conn, Creek, Dam, Day Use Area, Diversion, Extension, Falls, Ferry, Flyover, Frtg, Hill, Hospital, Island, Lake, Marina, MHP, Offramp, Onramp, Overhead, Overpass, Parkinglot, Passage, Picnicarea, Pk, Point, Pullout, Ramp, Recsite, Restarea, River, School, Seabus, Shoreline, Snowshed, Station, Stub, Terminal, TrailerCrt, Trailhead, Trestle, Tunnel, Underpass, Viaduct, WeighScale
tags A list of tags separated by semicolons (e.g., schools;courts;employment). A tag is a word used to describe the type of occupant you are searching for.
unitNumber The number of the unit, suite, or apartment within a house or building.
unitNumberSuffix A letter that follows the unit number as in Unit 1A.
unitDesignator The type of unit. Examples include APT, BLDG, BSMT, FLR, LOBBY, LWR, PAD, PH, REAR, RM, SIDE, SITE, SUITE, TH, UNIT, UPPR.
version Software version of the REST Web Service
websiteUrl Web site URL of occupant

Geocoder

glossary

Clone this wiki locally