Proximity Web Service methods

findNearest(line:Geometry, proximityOptions:ProximityOptions, token:string):ResultSet

findNearest(point:Point, proximityOptions:ProximityOptions, token:string):ResultSet

findWithin(line:Geometry, radius:double, proximityOptions:ProximityOptions, token:string):ResultSet

findWithin(point:Point, radius:double, proximityOptions:ProximityOptions, token:string):ResultSet

getAvailableFieldNames(proximityOptions:ProximityOptions):FieldDesc

getVersion:string

Method Name findNearest
Description Returns rows of fields and their values that are closest to a given line.
Endpoint URL http://arcweb.esri.com/services/v2/Proximity
Input Parameters
line Geometry
proximityOptions ProximityOptions
token string
Valid Arguments
line See parameter descriptions in Geometry.
proximityOptions See parameter descriptions in ProximityOptions.
token Authentication token
Output Parameter
Result ResultSet
Example (Java)

IProximity myProximity = ProximityHelper.bind() ;
ResultSet myResultSet = myProximity.findNearest(myGeometry, myProximityOptions, token);

Example (VB.NET)

Dim myProximity As New Proximity()
Dim myResultSet As New ResultSet()
myResultSet = myProximity.findNearest(myGeometry, myProximityOptions, token)

Example (C#.NET)

myProximity = new Proximity();
myResultSet = new ResultSet();
myResultSet = myProximity.findNearest(myGeometry, myProximityOptions, token);

 

Method Name findNearest
Description Returns rows of fields and their values that are closest to a given point.
Endpoint URL http://arcweb.esri.com/services/v2/Proximity
Input Parameters
point Point
proximityOptions ProximityOptions
token string
Valid Arguments
point x,y coordinate
proximityOptions See parameter descriptions in ProximityOptions.
token Authentication token
Output Parameter
Result ResultSet
Example (Java)

IProximity myProximity = ProximityHelper.bind();
ResultSet myResultSet = myProximity.findNearest(myPoint,myProximityOptions,token);

For myPoint, see Point.

For myProximityOptions, see ProximityOptions.

For token, see getToken.

Example (VB.NET)

Dim myProximity As New Proximity()
Dim myResultSet as New ResultSet()
myResultSet = myProximity.findNearest(myPoint,myProximityOptions,token)

For myPoint, see Point.

For myProximityOptions, see ProximityOptions.

For token, see getToken.

Example (C#.NET)

Proximity myProximity = new Proximity();
ResultSet myResultSet = myProximity.findNearest(myPoint,myProximityOptions,token);

For myPoint, see Point.

For myProximityOptions, see ProximityOptions.

For token, see getToken.

 

Method Name findWithin
Description Returns rows of fields and their values for a given line and a radius.
Endpoint URL http://arcweb.esri.com/services/v2/Proximity
Input Parameters
line Geometry
proximityOptions ProximityOptions
radius double
token string
Valid Arguments
line See parameter descriptions in Geometry.
radius Positive values that define a radius of a circle. Default unit is Miles (as set by ProximityOptions.units).
proximityOptions See parameter descriptions in ProximityOptions.
token Authentication token.
Output Parameter
Result ResultSet
Example (Java)

IProximity myProximity = ProximityHelper.bind() ;
double radius = 45.55;
ResultSet myResultSet = myProximity.findWithin(myGeometry, radius, myProximityOptions, token);

Example (VB.NET)

Dim myProximity As New Proximity()
Dim myResultSet As New ResultSet
Dim radius As Double
radius = 45.55
myResultSet = myProximity.findWithin(myGeometry, radius, myProximityOptions, token)

Example (C#.NET)

Proximity myProximity = new Proximity();
double radius = 45.55;
ResultSet myResultSet = myProximity.findWithin(myGeometry,radius,myProximityOptions,token);

 

Method Name findWithin
Description Returns rows of fields and their values for a given point and a radius.
Endpoint URL http://arcweb.esri.com/services/v2/Proximity
Input Parameters
point Point
proximityOptions ProximityOptions
radius double
token string
Valid Arguments
point x,y coordinate
radius Positive values that define a radius of a circle. Default unit is Miles (as set by ProximityOptions.units).
proximityOptions See parameter descriptions in ProximityOptions.
token Authentication token
Output Parameter
Result ResultSet
Example (Java)

IProximity myProximity = ProximityHelper.bind();
double radius = 45.55;
ResultSet myResultSet = myProximity.findWithin(myPoint,radius,myProximityOptions,token);

For myPoint, see Point.

For myProximityOptions, see ProximityOptions.

For token, see getToken.

Example (VB.NET)

Dim myProximity As New Proximity()
Dim radius As Double
radius = 45.55
Dim myResultSet As New ResultSet
myResultSet = myProximity.findWithin(myPoint, radius, myProximityOptions, token)

For myPoint, see Point.

For myProximityOptions, see ProximityOptions.

For token, see getToken.

Example (C#.NET)

Proximity myProximity = new Proximity();
double radius = 45.55;
ResultSet myResultSet = myProximity.findWithin(myPoint,radius,myProximityOptions,token);

For myPoint, see Point.

For myProximityOptions, see ProximityOptions.

For token, see getToken.

 

Method Name getAvailableFieldNames
Description Returns the fields (attributes) available for a given data source.
Endpoint URL http://arcweb.esri.com/services/v2/Proximity
Input Parameters
proximityOptions ProximityOptions
Valid Arguments
proximityOptions See parameter descriptions in ProximityOptions.
Output Parameter
Result FieldDesc [] containing array of available field names and field descriptions.
Example (Java)

IProximity myProximity = ProximityHelper.bind();
ProximityOptions myProximityOptions = new ProximityOptions();
myProximityOptions.dataSource = "User.Defined.POI";
FieldDesc[] myFieldDesc = myProximity.getAvailableFieldNames(myProximityOptions);

Example (VB.NET)

Dim myProximity As New Proximity()
Dim myFieldDesc() As FieldDesc
Dim myProximityOptions As New ProximityOptions()
myProximityOptionsdataSource = "User.Defined.POI"
myFieldDesc = myProximity.getAvailableFieldNames(myProximityOptions)

Example (C#.NET)

Proximity myProximity = new Proximity();
ProximityOptions myProximityOptions = new ProximityOptions();
myProximityOptions.dataSource = "User.Defined.POI";
FieldDesc[] myFieldDesc = myProximity.getAvailableFieldNames(myProximityOptions);

 

Method Name getVersion
Description Returns the version number of Proximity Web Service.
Endpoint URL http://arcweb.esri.com/services/v2/Proximity
Output Parameter
Result string
Example (Java)

IProximity myProximity = ProximityHelper.bind();
string version = myProximity.getVersion();

Example (VB.NET)

Dim myProximity As New Proximity()
Dim version as String
version = myProximity.getVersion()

Example (C#.NET)

Proximity myProximity = new Proximity();
string version = myProximity.getVersion();

 

See also

Proximity overview

Proximity data sources and credits

SOAP samples

Object model