/AWS1/CL_LOCPLACE

Contains details about addresses or points of interest that match the search criteria.

Not all details are included with all responses. Some details may only be returned by specific data partners.

CONSTRUCTOR

IMPORTING

Required arguments:

io_geometry TYPE REF TO /AWS1/CL_LOCPLACEGEOMETRY /AWS1/CL_LOCPLACEGEOMETRY

Geometry

Optional arguments:

iv_label TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.

iv_addressnumber TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

The numerical portion of an address, such as a building number.

iv_street TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

The name for a street or a road to identify a location. For example, Main Street.

iv_neighborhood TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

The name of a community district. For example, Downtown.

iv_municipality TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

A name for a local area, such as a city or town name. For example, Toronto.

iv_subregion TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

A county, or an area that's part of a larger region. For example, Metro Vancouver.

iv_region TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

A name for an area or geographical division, such as a province or state name. For example, British Columbia.

iv_country TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

iv_postalcode TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

iv_interpolated TYPE /AWS1/LOCSENSITIVEBOOLEAN /AWS1/LOCSENSITIVEBOOLEAN

True if the result is interpolated from other known places.

False if the Place is a known place.

Not returned when the partner does not provide the information.

For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.

io_timezone TYPE REF TO /AWS1/CL_LOCTIMEZONE /AWS1/CL_LOCTIMEZONE

The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner.

iv_unittype TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

For addresses with a UnitNumber, the type of unit. For example, Apartment.

Returned only for a place index that uses Esri as a data provider.

iv_unitnumber TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.

Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for SearchPlaceIndexForPosition.

it_categories TYPE /AWS1/CL_LOCPLACECATLIST_W=>TT_PLACECATEGORYLIST TT_PLACECATEGORYLIST

The Amazon Location categories that describe this Place.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service developer guide.

it_supplementalcategories TYPE /AWS1/CL_LOCPLACESUPPLEMENTA00=>TT_PLACESUPPLEMENTALCATLIST TT_PLACESUPPLEMENTALCATLIST

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

iv_submunicipality TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

An area that's part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York.

This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.

---

Queryable Attributes

Label

The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.

Accessible with the following methods

Method	Description
GET_LABEL()	Getter for LABEL, with configurable default
ASK_LABEL()	Getter for LABEL w/ exceptions if field has no value
HAS_LABEL()	Determine if LABEL has a value

Geometry

Geometry

Accessible with the following methods

Method	Description
GET_GEOMETRY()	Getter for GEOMETRY

AddressNumber

The numerical portion of an address, such as a building number.

Accessible with the following methods

Method	Description
GET_ADDRESSNUMBER()	Getter for ADDRESSNUMBER, with configurable default
ASK_ADDRESSNUMBER()	Getter for ADDRESSNUMBER w/ exceptions if field has no value
HAS_ADDRESSNUMBER()	Determine if ADDRESSNUMBER has a value

Street

The name for a street or a road to identify a location. For example, Main Street.

Accessible with the following methods

Method	Description
GET_STREET()	Getter for STREET, with configurable default
ASK_STREET()	Getter for STREET w/ exceptions if field has no value
HAS_STREET()	Determine if STREET has a value

Neighborhood

The name of a community district. For example, Downtown.

Accessible with the following methods

Method	Description
GET_NEIGHBORHOOD()	Getter for NEIGHBORHOOD, with configurable default
ASK_NEIGHBORHOOD()	Getter for NEIGHBORHOOD w/ exceptions if field has no value
HAS_NEIGHBORHOOD()	Determine if NEIGHBORHOOD has a value

Municipality

A name for a local area, such as a city or town name. For example, Toronto.

Accessible with the following methods

Method	Description
GET_MUNICIPALITY()	Getter for MUNICIPALITY, with configurable default
ASK_MUNICIPALITY()	Getter for MUNICIPALITY w/ exceptions if field has no value
HAS_MUNICIPALITY()	Determine if MUNICIPALITY has a value

SubRegion

A county, or an area that's part of a larger region. For example, Metro Vancouver.

Accessible with the following methods

Method	Description
GET_SUBREGION()	Getter for SUBREGION, with configurable default
ASK_SUBREGION()	Getter for SUBREGION w/ exceptions if field has no value
HAS_SUBREGION()	Determine if SUBREGION has a value

Region

A name for an area or geographical division, such as a province or state name. For example, British Columbia.

Accessible with the following methods

Method	Description
GET_REGION()	Getter for REGION, with configurable default
ASK_REGION()	Getter for REGION w/ exceptions if field has no value
HAS_REGION()	Determine if REGION has a value

Country

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

Accessible with the following methods

Method	Description
GET_COUNTRY()	Getter for COUNTRY, with configurable default
ASK_COUNTRY()	Getter for COUNTRY w/ exceptions if field has no value
HAS_COUNTRY()	Determine if COUNTRY has a value

PostalCode

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

Accessible with the following methods

Method	Description
GET_POSTALCODE()	Getter for POSTALCODE, with configurable default
ASK_POSTALCODE()	Getter for POSTALCODE w/ exceptions if field has no value
HAS_POSTALCODE()	Determine if POSTALCODE has a value

Interpolated

True if the result is interpolated from other known places.

False if the Place is a known place.

Not returned when the partner does not provide the information.

For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.

Accessible with the following methods

Method	Description
GET_INTERPOLATED()	Getter for INTERPOLATED, with configurable default
ASK_INTERPOLATED()	Getter for INTERPOLATED w/ exceptions if field has no value
HAS_INTERPOLATED()	Determine if INTERPOLATED has a value

TimeZone

The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner.

Accessible with the following methods

Method	Description
GET_TIMEZONE()	Getter for TIMEZONE

UnitType

For addresses with a UnitNumber, the type of unit. For example, Apartment.

Returned only for a place index that uses Esri as a data provider.

Accessible with the following methods

Method	Description
GET_UNITTYPE()	Getter for UNITTYPE, with configurable default
ASK_UNITTYPE()	Getter for UNITTYPE w/ exceptions if field has no value
HAS_UNITTYPE()	Determine if UNITTYPE has a value

UnitNumber

For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.

Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for SearchPlaceIndexForPosition.

Accessible with the following methods

Method	Description
GET_UNITNUMBER()	Getter for UNITNUMBER, with configurable default
ASK_UNITNUMBER()	Getter for UNITNUMBER w/ exceptions if field has no value
HAS_UNITNUMBER()	Determine if UNITNUMBER has a value

Categories

The Amazon Location categories that describe this Place.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service developer guide.

Accessible with the following methods

Method	Description
GET_CATEGORIES()	Getter for CATEGORIES, with configurable default
ASK_CATEGORIES()	Getter for CATEGORIES w/ exceptions if field has no value
HAS_CATEGORIES()	Determine if CATEGORIES has a value

SupplementalCategories

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

Accessible with the following methods

Method	Description
GET_SUPPLEMENTALCATEGORIES()	Getter for SUPPLEMENTALCATEGORIES, with configurable default
ASK_SUPPLEMENTALCATEGORIES()	Getter for SUPPLEMENTALCATEGORIES w/ exceptions if field has
HAS_SUPPLEMENTALCATEGORIES()	Determine if SUPPLEMENTALCATEGORIES has a value

SubMunicipality

An area that's part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York.

This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.

Accessible with the following methods

Method	Description
GET_SUBMUNICIPALITY()	Getter for SUBMUNICIPALITY, with configurable default
ASK_SUBMUNICIPALITY()	Getter for SUBMUNICIPALITY w/ exceptions if field has no val
HAS_SUBMUNICIPALITY()	Determine if SUBMUNICIPALITY has a value