complexType SearchNearestEdgeRequest

diagram
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  SearchNearestEdgeRequest
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. maxNumberOfCandidates   xsd:int   optional   1      documentation The maximum number of candidates the nearestSearch will return . 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. When specifying this attribute you might specify the returnedDistanceUnit attribute, otherwise the unit of maxDistance will be used. returnedWithinGeometryAttributeName   xsd:string   optional         documentation Specifies the name of an additional attribute to be added to the response containing a boolean that determines whether or not the search geometry is completely within the table geometry. returnedDistanceUnit   tns:DistanceUnit   optional         documentation Specifies the returned distance unit of measure. Default unit is the unit of maxDistance specified. returnedTablePointAttributeName   xsd:string   optional         documentation 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         documentation 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.
annotation	documentation 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. This differs from the searchNearest operation in the way polygons are handled. If the search geometry falls completely inside a MultiPolygon in the search table, the distance to the border is returned. Furthermore, if the table point or geometry point are requested, a point on the polygon edge will be returned rather than inside the polygon. An optional column that determines whether the search geometry is completely within the search geometry can also be returned.

attribute SearchNearestEdgeRequest/@maxNumberOfCandidates

type	xsd:int
properties	use  optional default  1
annotation	documentation The maximum number of candidates the nearestSearch will return .

attribute SearchNearestEdgeRequest/@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. When specifying this attribute you might specify the returnedDistanceUnit attribute, otherwise the unit of maxDistance will be used.

attribute SearchNearestEdgeRequest/@returnedWithinGeometryAttributeName

type	xsd:string
properties	use  optional
annotation	documentation Specifies the name of an additional attribute to be added to the response containing a boolean that determines whether or not the search geometry is completely within the table geometry.

attribute SearchNearestEdgeRequest/@returnedDistanceUnit

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

attribute SearchNearestEdgeRequest/@returnedTablePointAttributeName

type	xsd:string
properties	use  optional
annotation	documentation 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 SearchNearestEdgeRequest/@returnedGeometryPointAttributeName

type	xsd:string
properties	use  optional
annotation	documentation 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 SearchNearestEdgeRequest/maxDistance

diagram
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         documentation The unit of measure for this distance.
annotation	documentation The maximum distance the nearest search will perform. The search will stop at this distance even if no feature is found.

© 2019 Pitney Bowes Software Inc.

support.pb.com