complexType SpatialSearchRequest
diagram feature_p118.png
namespace http://www.mapinfo.com/midev/service/feature/v1
type extension of tns:SearchRequest
properties
base   tns:SearchRequest
abstract   true
children tns:Table tns:AttributeList tns:OrderByList
used by
complexTypes   ListFeaturesRequest SearchAtPointRequest searchByIdRequest SearchEnvelopeIntersectsRequest SearchIntersectsEnvelopeRequest SearchIntersectsRequest SearchNearestEdgeRequest SearchNearestRequest SearchWithinDistanceRequest SearchWithinEnvelopeRequest SearchWithinPolygonRequest
attributes
Name    Type    Use    Default    Fixed    Annotation
id    xsd:string    optional         
A unique identifier that is returned in the response. It is used for debugging or keeping track of asynchronous requests.
locale    xsd:string    optional         
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         
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      
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         
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      
Specify whether to return the total feature count for the search (not just the count for a requested page).
responseSrsName    xsd:string    optional         
Specifies the coordinate system of the returned geometry.
If not specified, the coordinate system of the table's geometry will be used.
description
A request base type for all spatial search requests. A spatial search uses geographic constraints to determine which features of the table to return.

attribute SpatialSearchRequest/@geometryAttributeName
type xsd:string
properties
use   optional
description
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.

attribute SpatialSearchRequest/@returnTotalCount
type xsd:boolean
properties
use   optional
default   false
description
Specify whether to return the total feature count for the search (not just the count for a requested page).

attribute SpatialSearchRequest/@responseSrsName
type xsd:string
properties
use   optional
description
Specifies the coordinate system of the returned geometry.
If not specified, the coordinate system of the table's geometry will be used.

element SpatialSearchRequest/AttributeList
diagram feature_p119.png
namespace http://www.mapinfo.com/midev/service/feature/v1
type tns:AttributeList
properties
minOcc   0
maxOcc   1
content   complex
children tns:AttributeName
attributes
Name    Type    Use    Default    Fixed    Annotation
exclude    xsd:boolean    optional    false      
If set to TRUE, the specified attributes will not be returned. A value of FALSE indicates that the specified attributes will be returned. The default value is FALSE.
description
Specify the attribute definition names of the table to be returned in the response. Each feature in the resulting feature collection will only contain the specified attributes. For example, if the table contains four attribute definitions but only two are required in the response, those two attribute definitions names can be specified here and the values for the other two will not be returned. If nothing is specified, all attributes in the table are returned.

element SpatialSearchRequest/OrderByList
diagram feature_p120.png
namespace http://www.mapinfo.com/midev/service/feature/v1
type tns:OrderByList
properties
minOcc   0
maxOcc   1
content   complex
children tns:OrderBy
description
Specify a sort order for the features in the resulting feature collection.



© 2013 Pitney Bowes Software Inc. Email: pbbi.support@pb.com