FRAMES | NO FRAMES
StdGeographiesByAttributesParams Type

Parameters of StdGeographiesByAttributes utility method.

Availability: Business Analyst Server, Business Analyst Online.

class StdGeographiesByAttributesParams : AnalysisParameters

Property Description
GeoLevelID The unique identifier for the standard geography level. The list of available geography levels could be retrieved with GetStandardGeographyLevels method. Type String.
SearchString A string to search in names of geography locations. Type String.
ActiveDatasetID ID of the active dataset. Type String. Available with Business Analyst Server. Inherited from AnalysisParameters.
IsFullErrorMessage Mode for composing error messages. Type Boolean. Available with Business Analyst Server. Inherited from AnalysisParameters.
OutputSpatialReference An option specifying the spatial reference to return the output feature layer in. 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.
token User authentication token received from Authentication Web Service. Type String. Available with Business Analyst Online. Inherited from AnalysisParameters.

Remarks

The SearchString property can contain up to two comma-separated substrings. The first substring specifies the criterion for search in the location name field and the last substring specifies the criterion for search in the location ID field. If the second string is omitted together with delimiting comma, the search is applied to both location names and IDs with the same search criterion. The search is applied using logical "or" operation: a location matches the search criterion if either its name contains the name search substring or its ID contains the ID search substring. The case of an empty name or ID search substring means skipping search by name or ID, respectively. If both substrings are empty, all locations of the standard geography level are returned.

Example Description
"San,123" Searches location name containing "San" substring or location ID containing "123" substring.
"123" Searches location name containing "123" substring or location ID containing "123" substring.
",123" Searches location ID containing "123" substring.
"San," Searches location name containing "San" substring.
"," Returns all locations of the standard geography level.

See Also