complexType SearchNearestRequest
diagram feature_p106.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:maxDistance tns:Geometry
used by
element   SearchNearestRequest
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.
maxNumberOfCandidates    xsd:int    optional    1      
The maximum number of candidates the nearestSearch will return .
returnedDistanceAttributeName    xsd:string    optional         
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. When specifying this attribute you might specify the returnedDistanceUnit attribute, otherwise the unit of maxDistance will be used.
returnedDistanceUnit    tns:DistanceUnit    optional         
Specifies the returned distance unit of measure. Default unit is the unit of maxDistance specified.
returnedTablePointAttributeName    xsd:string    optional         
Used to return the nearest point on the searched table geometry. Specifies the name of an additional attribute to be added to the response containing the nearest point on the geometry from the table, of minimal distance to the specified request geometry. No attribute will be added if this is not specified.
returnedGeometryPointAttributeName    xsd:string    optional         
Used to return the nearest point on the request geometry. Specifies the name of an additional attribute to be added to the response containing a point on the specified request geometry, of minimal distance to the geometry from the searched table. No attribute will be added if this is not specified.
description
A request to search the table for the features that are closest to a specified geometry. The features will be returned sorted from closest to farthest.

attribute SearchNearestRequest/@maxNumberOfCandidates
type xsd:int
properties
use   optional
default   1
description
The maximum number of candidates the nearestSearch will return .

attribute SearchNearestRequest/@returnedDistanceAttributeName
type xsd:string
properties
use   optional
description
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. When specifying this attribute you might specify the returnedDistanceUnit attribute, otherwise the unit of maxDistance will be used.

attribute SearchNearestRequest/@returnedDistanceUnit
type tns:DistanceUnit
properties
use   optional
facets
Kind   Value   Annotation
enumeration   Centimeter
The distance unit for: centimeter.
enumeration   cm
The distance unit for: centimeter.
enumeration   Chain
The distance unit for: chain.
enumeration   Foot
The distance unit for: foot.
enumeration   ft
The distance unit for: foot.
enumeration   Inch
The distance unit for: inch.
enumeration   in
The distance unit for: inch.
enumeration   Kilometer
The distance unit for: kilometer.
enumeration   km
The distance unit for: kilometer.
enumeration   Link
The distance unit for: link.
enumeration   Meter
The distance unit for: meter.
enumeration   m
The distance unit for: meter.
enumeration   Mile
The distance unit for: mile.
enumeration   mi
The distance unit for: mile.
enumeration   Millimeter
The distance unit for: millimeter.
enumeration   mm
The distance unit for: millimeter.
enumeration   NauticalMile
The distance unit for: nautical mile.
enumeration   Pica
The distance unit for: pica.
enumeration   Point
The distance unit for: point.
enumeration   Rod
The distance unit for: rod.
enumeration   SurveyFoot
The distance unit for: survey foot.
enumeration   Twip
The distance unit for: twip.
enumeration   Yard
The distance unit for: yard.
enumeration   yd
The distance unit for: yard.
description
Specifies the returned distance unit of measure. Default unit is the unit of maxDistance specified.

attribute SearchNearestRequest/@returnedTablePointAttributeName
type xsd:string
properties
use   optional
description
Used to return the nearest point on the searched table geometry. Specifies the name of an additional attribute to be added to the response containing the nearest point on the geometry from the table, of minimal distance to the specified request geometry. No attribute will be added if this is not specified.

attribute SearchNearestRequest/@returnedGeometryPointAttributeName
type xsd:string
properties
use   optional
description
Used to return the nearest point on the request geometry. Specifies the name of an additional attribute to be added to the response containing a point on the specified request geometry, of minimal distance to the geometry from the searched table. No attribute will be added if this is not specified.

element SearchNearestRequest/maxDistance
diagram feature_p107.png
namespace http://www.mapinfo.com/midev/service/feature/v1
type tns:Distance
properties
minOcc   0
maxOcc   1
content   complex
attributes
Name    Type    Use    Default    Fixed    Annotation
uom    tns:DistanceUnit    required         
The unit of measure for this distance.
description
The maximum distance the nearest search will perform. The search will stop at this distance even if no feature is found.



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