ReturnStdGeographyParams Type

Parameters of ReturnStdGeography utility method.

Availability: Business Analyst Server 9.3.1.

class ReturnStdGeographyParams : AnalysisParameters

Property Description

Address Location address fields. Type String[].

GeoLevelIDs Array containing IDs of standard geography levels to find geography features. The list of available geography levels could be retrieved with the GetStandardGeographyLevels method. Type String[].

Point Location coordinates. Type Point. Available with Business Analyst Server 10.0.

Points Point data layer. Type PointLayer. Available with Business Analyst Server 10.0.

ZIP Location ZIP Code. Type String.

ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.

IsFullErrorMessage Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.

OutputSpatialReference An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.

ReturnGeometry An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
Default: true.

Property	Description
Address	Location address fields. Type String[].
GeoLevelIDs	Array containing IDs of standard geography levels to find geography features. The list of available geography levels could be retrieved with the GetStandardGeographyLevels method. Type String[].
Point	Location coordinates. Type Point. Available with Business Analyst Server 10.0.
Points	Point data layer. Type PointLayer. Available with Business Analyst Server 10.0.
ZIP	Location ZIP Code. Type String.
ActiveDatasetID	ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage	Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.
OutputSpatialReference	An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
ReturnGeometry	An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters. Default: true.

Remarks

The GeoLevelIDs property specifies IDs of the standard geography levels to search features in.

The location point can be specified in one of three ways—by postal address, by geographic coordinates, and by ZIP code:

The Address property specifies postal address fields.
The Point property specifies geographic coordinates of the point along with its spatial reference.
The ZIP property specifies the location ZIP code. The centroid point of the given ZIP code is used.

Since Business Analyst Server 10.0, the Points parameter is introduced. It allows you to specify multiple points using a point layer. In this case, features matching to the given locations are combined together and the combined feature ID and Name is returned for a geography level. The ID of a combined feature can be used in the GeographyIDs parameter of the StdLayer type and the StandardLevelsOfGeography method.

NOTE: The ways for specifying geography locations are mutually exclusive. Only one property from Address, Point, ZIP, and Points should be specified and others should be null.

Remarks

See Also