Geoportal Resources Access API Reference

Namespace: GeocodedLocation

Gp.Services.Geocode.GeocodedLocation

.Geocode.

Single location object returned by the underlying geocoding web service.

Properties:
Name Type Description
position Gp.Point

Position of the location given in the requested coordinates system.

type String

location type "StreetAddress" (for an address), "PositionOfInterest" (for a place name) or "CadastralParcel" (for cadastral parcel).

matchType String

how geocoding is performed : "street number" (exact address), "street enhanced" (street number calculated by interpolation), "street" (only the street), "city" (only the city).

accuracy Float

Accuracy of the response towards the requested location between 0 (unaccurate) and 1 (exact match).

placeAttributes Object

Associative array matching the following attributes with their values given by the underlying web service :

*Common attributes : *

  • trueGeometry - the 'real life' geometry if different from 'Point' type.

if type === "StreetAddress" :

  • number - Street number.
  • postalCode - PostCode
  • street - Street name
  • city - City
  • houseNumberInfos - additional street number information
  • inseeCode - INSEE Code

if type === "PositionOfInterest" :

  • type - Place name type
  • postalCode - PostCode
  • toponyme - Toponyme
  • extraFields - additional place name properties
  • inseeCode - INSEE Code

si type = "CadastralParcel" :

  • codeCommuneAbs - when a parcel comes from a city that was absorbed by another, code of that old city. "000" otherwise.
  • codeArrondissement - arrondissement
  • identifiant - cadastral parcel code
  • feuille - Parcel Sheet (eg. "1").
  • numero - Parcel Number (eg. "0041")
  • section - Parcel Section (eg. "0D").
  • nomCommune - Parcel municipality name.
  • codeCommune - Parcel municipality.
  • codeDepartement - Parcel Department.