complexType SearchWithinDistanceRequest
diagram feature_p111.png
namespace http://www.mapinfo.com/midev/service/feature/v1
type extension of tns:SpatialSearchRequest
properties
base tns:SpatialSearchRequest
children tns:Table tns:AttributeList tns:OrderByList tns:Distance tns:Geometry
used by
element SearchWithinDistanceRequest
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xsd:string  optional      
documentation
A unique identifier that is returned in the response. It is used for debugging or keeping track of asynchronous requests.
locale  xsd:string  optional      
documentation
The language and country code of the request, which is defined using [language_code]_[country_code] syntax. The language code is a 2-letter ISO-639 code. The country code is a 2-letter ISO-3166 code. For example: en_US stands for the English language within the United States of America.
pageLength  xsd:int  optional      
documentation
The maximum number of features to be returned in the resulting feature collection. If this is not specified, the whole response is returned.
pageNumber  xsd:int  optional  1    
documentation
The page to be returned. The page is a subset of the entire response and based on the 'pageLength' attribute. The page count begins at 1. For example, if the response normally contains 35 features and the 'pageLength' attribute is set to 8, there will be 5 pages (numbered 1 through 5).
geometryAttributeName  xsd:string  optional      
documentation
Specify which geometry attribute definitions in the table should be used for processing the spatial query. This attribute is only required for tables that contain more than one geometry attribute definitions.
returnTotalCount  xsd:boolean  optional  false    
documentation
Specify whether to return the total feature count for the search (not just the count for a requested page).
responseSrsName  xsd:string  optional      
documentation
Specifies the coordinate system of the returned geometry.
If not specified, the coordinate system of the table's geometry will be used.
returnedDistanceAttributeName  xsd:string  optional      
documentation
Specifies the name of an additional attribute to be added to the response containing the distance between the feature and the specified geometry. No attribute will be added if this is not specified.
interaction  tns:interactionType  optional  within    
documentation
Indicates the type of spatial search applied to the search distance when comparing geometries in the table with that of the specified geometry. There are three types of searches available: intersects, within, and envelopeintersect.
annotation
documentation
A request to search the table for features that are either entirely, partially, or whose envelope intersects the specified geometry within a certain distance.

attribute SearchWithinDistanceRequest/@returnedDistanceAttributeName
type xsd:string
properties
use optional
annotation
documentation
Specifies the name of an additional attribute to be added to the response containing the distance between the feature and the specified geometry. No attribute will be added if this is not specified.

attribute SearchWithinDistanceRequest/@interaction
type tns:interactionType
properties
use optional
default within
facets
Kind Value Annotation
enumeration intersects
documentation
Geometries returned are either within or intersect the search area.
enumeration within
documentation
Geometries returned are completely within the search area.
enumeration envelopesIntersect
documentation
Geometries returned are either within, intersect, or their geometries envelope intersects the search area.
annotation
documentation
Indicates the type of spatial search applied to the search distance when comparing geometries in the table with that of the specified geometry. There are three types of searches available: intersects, within, and envelopeintersect.

element SearchWithinDistanceRequest/Distance
diagram feature_p112.png
namespace http://www.mapinfo.com/midev/service/feature/v1
type tns:Distance
properties
content complex
attributes
Name  Type  Use  Default  Fixed  Annotation
uom  tns:DistanceUnit  required      
documentation
The unit of measure for this distance.
annotation
documentation
The search distance from the specified geometry.


© 2007, 2020 Precisely. All rights reserved. support.precisely.com