/AWS1/CL_GEPGETPLACERESPONSE¶
GetPlaceResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_placeid TYPE /AWS1/GEPSENSITIVESTRING /AWS1/GEPSENSITIVESTRING¶
The
PlaceIdof the place you wish to receive the information for.
iv_placetype TYPE /AWS1/GEPPLACETYPE /AWS1/GEPPLACETYPE¶
A
PlaceTypeis a category that the result place must belong to.
iv_title TYPE /AWS1/GEPSENSITIVESTRING /AWS1/GEPSENSITIVESTRING¶
The localized display name of this result item based on request parameter
language.
iv_pricingbucket TYPE /AWS1/GEPSTRING /AWS1/GEPSTRING¶
The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
Optional arguments:¶
io_address TYPE REF TO /AWS1/CL_GEPADDRESS /AWS1/CL_GEPADDRESS¶
The place's address.
iv_addressnumbercorrected TYPE /AWS1/GEPSENSITIVEBOOLEAN /AWS1/GEPSENSITIVEBOOLEAN¶
Boolean indicating if the address provided has been corrected. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
it_postalcodedetails TYPE /AWS1/CL_GEPPOSTALCODEDETAILS=>TT_POSTALCODEDETAILSLIST TT_POSTALCODEDETAILSLIST¶
Contains details about the postal code of the place/result. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
it_position TYPE /AWS1/CL_GEPPOSITION_W=>TT_POSITION TT_POSITION¶
The position in World Geodetic System (WGS 84) format: [longitude, latitude].
it_mapview TYPE /AWS1/CL_GEPBOUNDINGBOX_W=>TT_BOUNDINGBOX TT_BOUNDINGBOX¶
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set of four coordinates:
[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
it_categories TYPE /AWS1/CL_GEPCATEGORY=>TT_CATEGORYLIST TT_CATEGORYLIST¶
Categories of results that results must belong to.
it_foodtypes TYPE /AWS1/CL_GEPFOODTYPE=>TT_FOODTYPELIST TT_FOODTYPELIST¶
List of food types offered by this result. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
it_businesschains TYPE /AWS1/CL_GEPBUSINESSCHAIN=>TT_BUSINESSCHAINLIST TT_BUSINESSCHAINLIST¶
The Business Chains associated with the place.
io_contacts TYPE REF TO /AWS1/CL_GEPCONTACTS /AWS1/CL_GEPCONTACTS¶
List of potential contact methods for the result/place. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
it_openinghours TYPE /AWS1/CL_GEPOPENINGHOURS=>TT_OPENINGHOURSLIST TT_OPENINGHOURSLIST¶
List of opening hours objects. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
it_accesspoints TYPE /AWS1/CL_GEPACCESSPOINT=>TT_ACCESSPOINTLIST TT_ACCESSPOINTLIST¶
Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
it_accessrestrictions TYPE /AWS1/CL_GEPACCESSRESTRICTION=>TT_ACCESSRESTRICTIONLIST TT_ACCESSRESTRICTIONLIST¶
Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
io_timezone TYPE REF TO /AWS1/CL_GEPTIMEZONE /AWS1/CL_GEPTIMEZONE¶
The time zone in which the place is located.
iv_politicalview TYPE /AWS1/GEPCOUNTRYCODE3 /AWS1/GEPCOUNTRYCODE3¶
The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
io_phonemes TYPE REF TO /AWS1/CL_GEPPHONEMEDETAILS /AWS1/CL_GEPPHONEMEDETAILS¶
How the various components of the result's address are pronounced in various languages. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
io_mainaddress TYPE REF TO /AWS1/CL_GEPRELATEDPLACE /AWS1/CL_GEPRELATEDPLACE¶
The main address corresponding to a place of type Secondary Address. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
it_secondaryaddresses TYPE /AWS1/CL_GEPRELATEDPLACE=>TT_RELATEDPLACELIST TT_RELATEDPLACELIST¶
All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.
Queryable Attributes¶
PlaceId¶
The
PlaceIdof the place you wish to receive the information for.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLACEID() |
Getter for PLACEID, with configurable default |
ASK_PLACEID() |
Getter for PLACEID w/ exceptions if field has no value |
HAS_PLACEID() |
Determine if PLACEID has a value |
PlaceType¶
A
PlaceTypeis a category that the result place must belong to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLACETYPE() |
Getter for PLACETYPE, with configurable default |
ASK_PLACETYPE() |
Getter for PLACETYPE w/ exceptions if field has no value |
HAS_PLACETYPE() |
Determine if PLACETYPE has a value |
Title¶
The localized display name of this result item based on request parameter
language.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TITLE() |
Getter for TITLE, with configurable default |
ASK_TITLE() |
Getter for TITLE w/ exceptions if field has no value |
HAS_TITLE() |
Determine if TITLE has a value |
PricingBucket¶
The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRICINGBUCKET() |
Getter for PRICINGBUCKET, with configurable default |
ASK_PRICINGBUCKET() |
Getter for PRICINGBUCKET w/ exceptions if field has no value |
HAS_PRICINGBUCKET() |
Determine if PRICINGBUCKET has a value |
Address¶
The place's address.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ADDRESS() |
Getter for ADDRESS |
AddressNumberCorrected¶
Boolean indicating if the address provided has been corrected. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ADDRESSNUMBERCORRECTED() |
Getter for ADDRESSNUMBERCORRECTED, with configurable default |
ASK_ADDRESSNUMBERCORRECTED() |
Getter for ADDRESSNUMBERCORRECTED w/ exceptions if field has |
HAS_ADDRESSNUMBERCORRECTED() |
Determine if ADDRESSNUMBERCORRECTED has a value |
PostalCodeDetails¶
Contains details about the postal code of the place/result. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POSTALCODEDETAILS() |
Getter for POSTALCODEDETAILS, with configurable default |
ASK_POSTALCODEDETAILS() |
Getter for POSTALCODEDETAILS w/ exceptions if field has no v |
HAS_POSTALCODEDETAILS() |
Determine if POSTALCODEDETAILS has a value |
Position¶
The position in World Geodetic System (WGS 84) format: [longitude, latitude].
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POSITION() |
Getter for POSITION, with configurable default |
ASK_POSITION() |
Getter for POSITION w/ exceptions if field has no value |
HAS_POSITION() |
Determine if POSITION has a value |
MapView¶
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set of four coordinates:
[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAPVIEW() |
Getter for MAPVIEW, with configurable default |
ASK_MAPVIEW() |
Getter for MAPVIEW w/ exceptions if field has no value |
HAS_MAPVIEW() |
Determine if MAPVIEW has a value |
Categories¶
Categories of results that results must belong to.
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 |
FoodTypes¶
List of food types offered by this result. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FOODTYPES() |
Getter for FOODTYPES, with configurable default |
ASK_FOODTYPES() |
Getter for FOODTYPES w/ exceptions if field has no value |
HAS_FOODTYPES() |
Determine if FOODTYPES has a value |
BusinessChains¶
The Business Chains associated with the place.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUSINESSCHAINS() |
Getter for BUSINESSCHAINS, with configurable default |
ASK_BUSINESSCHAINS() |
Getter for BUSINESSCHAINS w/ exceptions if field has no valu |
HAS_BUSINESSCHAINS() |
Determine if BUSINESSCHAINS has a value |
Contacts¶
List of potential contact methods for the result/place. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTACTS() |
Getter for CONTACTS |
OpeningHours¶
List of opening hours objects. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OPENINGHOURS() |
Getter for OPENINGHOURS, with configurable default |
ASK_OPENINGHOURS() |
Getter for OPENINGHOURS w/ exceptions if field has no value |
HAS_OPENINGHOURS() |
Determine if OPENINGHOURS has a value |
AccessPoints¶
Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCESSPOINTS() |
Getter for ACCESSPOINTS, with configurable default |
ASK_ACCESSPOINTS() |
Getter for ACCESSPOINTS w/ exceptions if field has no value |
HAS_ACCESSPOINTS() |
Determine if ACCESSPOINTS has a value |
AccessRestrictions¶
Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCESSRESTRICTIONS() |
Getter for ACCESSRESTRICTIONS, with configurable default |
ASK_ACCESSRESTRICTIONS() |
Getter for ACCESSRESTRICTIONS w/ exceptions if field has no |
HAS_ACCESSRESTRICTIONS() |
Determine if ACCESSRESTRICTIONS has a value |
TimeZone¶
The time zone in which the place is located.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TIMEZONE() |
Getter for TIMEZONE |
PoliticalView¶
The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POLITICALVIEW() |
Getter for POLITICALVIEW, with configurable default |
ASK_POLITICALVIEW() |
Getter for POLITICALVIEW w/ exceptions if field has no value |
HAS_POLITICALVIEW() |
Determine if POLITICALVIEW has a value |
Phonemes¶
How the various components of the result's address are pronounced in various languages. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PHONEMES() |
Getter for PHONEMES |
MainAddress¶
The main address corresponding to a place of type Secondary Address. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAINADDRESS() |
Getter for MAINADDRESS |
SecondaryAddresses¶
All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information. Not available in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECONDARYADDRESSES() |
Getter for SECONDARYADDRESSES, with configurable default |
ASK_SECONDARYADDRESSES() |
Getter for SECONDARYADDRESSES w/ exceptions if field has no |
HAS_SECONDARYADDRESSES() |
Determine if SECONDARYADDRESSES has a value |