Geoportal Resources Access API Reference

Namespace: GeocodedLocation

Gp.Services.Geocode.GeocodedLocation

Location object holding common properties returned by the underlying geocoding and reverse 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).

placeAttributes Object

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

Common attributes :

  • freeform - freeform complete Address.
  • bbox - Bounding Box Gp.BBox.
  • municipality - Municipality

if type === "StreetAddress" :

  • number - Street number.
  • ID - Identifier of the address in the BD ADRESSE Database.
  • IDTR - Identifier of the lineString in the BD ADRESSE Database.
  • postalCode - PostCode
  • quality - Geocoding quality (see)
  • street - Street name
  • territory - French Territory code
  • commune - City
  • department - Department
  • insee - INSEE Code

if type === "PositionOfInterest" :

  • importance - Place name importance
  • nature - Place name nature
  • postalCode - PostCode
  • territory - French Territory code
  • commune - City
  • department - Department
  • insee - INSEE Code

si type = "CadastralParcel" :

  • absorbedCity - when a parcel comes from a city that was absorbed by another, code of that old city. "000" otherwise.
  • arrondissement - arrondissement
  • cadastralParcel - cadastral parcel code
  • district - district
  • sheet - Parcel Sheet (eg. "1").
  • number - Parcel Number (eg. "0041")
  • section - Parcel Section (eg. "0D").
  • commune - Parcel municipality.
  • department - Parcel Department.
  • insee - INSEE Code.
  • origin - Parcel origin (see "type" attribute in the underlying web service response)