IGetGeographyOptions

Interface

Inheritance: IGetGeographyOptionsIEndpointOptions

Properties

PropertyTypeNotes
authentication
 optional 

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

credentials
 optional 
RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

endpoint
 optional 
string

Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )

featureLimit
 optional 
number

Limits the number of features that are returned from the geographyQuery parameter.

featureOffset
 optional 
number

Starts the results on the number of the records specified.

number

Integer that specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers.

geographyIDs
 optional 
string[]

Specify which IDs for the standard geography layers are being queried or searched.

geographyLayers
 optional 
string | string[]

Specify which standard geography layers are being queried or searched.

geographyQuery
 optional 
string

Specify the text to query and search the standard geography layers specified.

headers
 optional 
{ [key: string]: any }

Additional Headers to pass into the request.

hideToken
 optional 
boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod
 optional 

The HTTP method to send the request with.

langCode
 optional 
string

Specifies the language you wish to receive your GeoEnrichment results.

maxUrlLength
 optional 
number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

string

Specify a specific dataset within a defined country.

outSR
 optional 
number

Request the output geometries in a specified spatial reference system.

params
 optional 

Additional parameters to pass in the request.

portal
 optional 
string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

rawResponse
 optional 
boolean

Return the raw response

returnCentroids
 optional 
boolean

Request the output geometry to return the center point for each feature.

returnGeometry
 optional 
boolean

Request the output geometries in the response.

boolean

Return all the subgeographic areas that are within a parent geography.

signal
 optional 
AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

sourceCountry
 optional 
string

Specify the source country for the search.

subGeographyLayer
 optional 
string

Return all the subgeographic areas that are within a parent geography.

subGeographyQuery
 optional 
string

Filter the results of the subgeography features that are returned by a search term.

suppressWarnings
 optional 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

useFuzzySearch
 optional 
boolean

Define if text provided in the geographyQuery parameter should utilize fuzzy search logic.

authentication optional

authentication: string | IAuthenticationManager

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

credentials optional

credentials: RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

endpoint optional

endpoint: string

Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )

featureLimit optional

featureLimit: number

Limits the number of features that are returned from the geographyQuery parameter.

featureOffset optional

featureOffset: number

Starts the results on the number of the records specified.

generalizationLevel optional

generalizationLevel: number

Integer that specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers.

geographyIDs optional

geographyIDs: string[]

Specify which IDs for the standard geography layers are being queried or searched.

geographyLayers optional

geographyLayers: string | string[]

Specify which standard geography layers are being queried or searched.

geographyQuery optional

geographyQuery: string

Specify the text to query and search the standard geography layers specified.

headers optional

headers: { [key: string]: any }

Additional Headers to pass into the request.

hideToken optional

hideToken: boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod optional

httpMethod: HTTPMethods

The HTTP method to send the request with.

langCode optional

langCode: string

Specifies the language you wish to receive your GeoEnrichment results.

maxUrlLength optional

maxUrlLength: number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

optionalCountryDataset optional

optionalCountryDataset: string

Specify a specific dataset within a defined country.

outSR optional

outSR: number

Request the output geometries in a specified spatial reference system.

params optional

params: IParams

Additional parameters to pass in the request.

portal optional

portal: string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

rawResponse optional

rawResponse: boolean

Return the raw response

returnCentroids optional

returnCentroids: boolean

Request the output geometry to return the center point for each feature.

returnGeometry optional

returnGeometry: boolean

Request the output geometries in the response.

returnSubGeographyLayer optional

returnSubGeographyLayer: boolean

Return all the subgeographic areas that are within a parent geography.

signal optional

signal: AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

sourceCountry optional

sourceCountry: string

Specify the source country for the search.

subGeographyLayer optional

subGeographyLayer: string

Return all the subgeographic areas that are within a parent geography.

subGeographyQuery optional

subGeographyQuery: string

Filter the results of the subgeography features that are returned by a search term.

suppressWarnings optional

suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

useFuzzySearch optional

useFuzzySearch: boolean

Define if text provided in the geographyQuery parameter should utilize fuzzy search logic.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.