POI Manager Web Service methods

addLocation(poi:Poi, geocode:boolean, keepFormatting:boolean, poiManagerOptions:PoiManagerOptions, token:string):integer

deleteAll
(token:string):integer

deleteLocations
(ids:string[], token:string):integer

findLocations
(queryParams:QueryParams, token:string):PoiResultSet

getPoiTypes
(token:string):string[]

getVersion
:string

updateLocation
(id:string, poi:Poi, regeocode:boolean, poiManagerOptions:PoiManagerOptions, token:string):integer

 

Method Name

addLocation

Description

Adds a POI record to your set of points stored on the ESRI Server.

Endpoint URL

http://arcweb.esri.com/services/v2/PoiManager

Input Parameters

poi

Poi

geocode

boolean

keepFormatting

boolean

poiManagerOptions

PoiManagerOptions

token

string

Valid Arguments

poi

See parameter descriptions in Poi.

geocode

"true" means POI will be geocoded by the server; "false" means POI will not be geocoded.

keepFormatting

"true" means user-defined address format is maintained; "false" means geocoder standardizes format if necessary.

poiManagerOptions

See parameter descriptions in PoiManagerOptions.

token

Authentication token

Output Parameter

Result

-1 (not geocoded), 0 (exact match), or 1 (geocode with multiple matches)

Example (Java)

IPoiManager myPoiManager = PoiManagerHelper.bind() ;
int myPoiRecord = myPoiManager.addLocation(myPoi,false,false,myPoiManagerOptions,token)

Example (VB.NET)

Dim myPoiManager As New PoiManager()
Dim myPoiRecord As Integer
myPoiRecord = myPoiManager.addLocation(myPoi, true, true, myPoiManagerOptions, token)

Example (C#.NET)

PoiManager myPoiManager = new PoiManager();
int myPoiRecord;
myPoiRecord = myPoiManager.addLocation(myPoi, true, true, myPoiManagerOptions, token);

 

Method Name

deleteAll

Description

Deletes all your POI records on the ESRI Server. Note: No warning message is returned before the records are deleted. Be sure you want to delete your POI data set before you send this method.

Endpoint URL

http://arcweb.esri.com/services/v2/PoiManager

Input Parameters

token

string

Valid Arguments

token

Authentication token for accessing POI Manager Web Service.

Output Parameter

Result

number of POI records that were deleted.

Example (Java)

IPoiManager myPoiManager = PoiManagerHelper.bind() ;
int myResult = myPoiManager.deleteAll(token);

Example (VB.NET)

Dim myPoiManager As New PoiManager()
Dim myResult As Integer
myResult = myPoiManager.deleteAll(token)

Example (C#.NET)

PoiManager myPoiManager = new PoiManager();
int myResult = myPoiManager.deleteAll(token);

 

Method Name

deleteLocations

Description

Deletes individual POI records on the ESRI Server.

Endpoint URL

http://arcweb.esri.com/services/v2/PoiManager

Input Parameters

ids

string[]

token

string

Valid Arguments

ids

IDs of records to be deleted.

token

Authentication token for accessing POI Manager Web Service.

Output Parameter

Result

number of POI records that were deleted.

Example (Java)

String[] myRecords = new String[3];
myRecords[0] = "1";
myRecords[1] = "27";
myRecords[2] = "35";

IPoiManager myPoiManager = PoiManagerHelper.bind();
int myResult = myPoiManager.deleteLocations(myRecords, token);

Example (VB.NET)

Dim myPoiManager As New PoiManager()
Dim myLocations(2) As String
Dim myResult As Integer
myLocations(0) = "1"
myLocations(1) = "27"
myLocations(2) = "35"
myResult = myPoiManager.deleteLocations(myLocations, token)

Example (C#.NET)

PoiManager myPoiManager = new PoiManager();
String[2] myLocations;
int myResult;
myLocations[0] = "1";
myLocations[1] = "27";
myLocations[2] = "35";
myResult = myPoiManager.deleteLocations(myLocations, token);

 

Method Name

findLocations

Description

Returns all the POI locations that meet the query parameters.

Endpoint URL

http://arcweb.esri.com/services/v2/PoiManager

Input Parameters

queryParams

QueryParams

token

string

Valid Arguments

queryParams

See parameter descriptions in QueryParams.  

token

Authentication token

Output Parameter

Result

PoiResultSet. Note: The point parameter in the POI object is returned null.

Example (Java)

IPoiManager myPoiManager = PoiManagerHelper.bind() ;
PoiResultSet myPoiResultSet = myPoiManager.findLocations(myQueryParams, token);

Example (VB.NET)

Dim myPoiManager As New PoiManager()
Dim myPoiResultSet As New PoiResultSet()
Dim myQueryParams As New QueryParams()
myPoiResultSet = myPoiManager.findLocations(myQueryParams, token)

Example (C#.NET)

PoiManager myPoiManager = new PoiManager();
PoiResultSet myPoiResultSet = new PoiResultSet();
QueryParams myQueryParams = new QueryParams();
myPoiResultSet = myPoiManager.findLocations(myQueryParams, token);

 

Method Name

getPoiTypes

Description

Returns a list of your POI types.

Endpoint URL

http://arcweb.esri.com/services/v2/PoiManager

Input Parameters

token

string

Valid Arguments

token

Authentication token

Output Parameter

Result

string[]

Example (Java)

IPoiManager myPoiManager = PoiManagerHelper.bind() ;
String[] myTypes = myPoiManager.getPoiTypes(token);
for (int i = 0; i < myTypes.length; i++) {
System.out.println(myTypes[i]);
}

Example (VB.NET)

Dim myPoiManager As New PoiManager()
Dim myTypes() As String
Dim i As Integer
myTypes = myPoiManager.getPoiTypes(token)
For i = 0 to (myTypes.Length - 1)
Console.WriteLine(myTypes(i))
Next

Example (C#.NET)

PoiManager myPoiManager = new PoiManager();
int i;
String[] myTypes = myPoiManager.getPoiTypes(token);
for (i = 0; i < myTypes.Length; i++)
{
Console.WriteLine(myTypes[i]);
}

 

Method Name

getVersion

Description

Returns the version number of POI Manager Web Service.

Endpoint URL

http://arcweb.esri.com/services/v2/PoiManager

Output Parameter

Result

string

Example (Java)

IPoiManager myPoiManager = PoiManagerHelper.bind();
string version = myPoiManager.getVersion();

Example (VB.NET)

Dim myPoiManager As New PoiManager()
Dim myVersion As String
myVersion = myPoiManager.getVersion()

Example (C#.NET)

PoiManager myPoiManager = new PoiManager();
string myVersion;
myVersion = myPoiManager.getVersion();

 

Method Name

updateLocation

Description

Updates a POI record.

Endpoint URL

http://arcweb.esri.com/services/v2/PoiManager

Input Parameters

id

string

poi

Poi

regeocode

boolean

poiManagerOptions

PoiManagerOptions

token

string

Valid Arguments

id

ID of record to be updated.

poi

See parameter descriptions in Poi.

regeocode

"true" means record is geocoded again; "false" means record is not geocoded again.

poiManagerOptions

See parameter descriptions in PoiManagerOptions.

token

Authentication token

Output Parameter

Result

-1 (not geocoded), 0 (exact match), or 1 (geocode with multiple matches)

Example (Java)

IPoiManager myPoiManager = PoiManagerHelper.bind() ;
int myResult = myPoiManager.updateLocation(myId, myPoi, true, myPoiManagerOptions, token);

Example (VB.NET)

Dim myPoiManager As New PoiManager()
Dim myResult As Integer
myResult = myPoiManager.updateLocation(myId, myPoi, true, myPoiManagerOptions, token)

Example (C#.NET)

PoiManager myPoiManager = new PoiManager();
int myResult;
myResult = myPoiManager.updateLocation(myId, myPoi, true, myPoiManagerOptions, token);

 


See also

POI Manager overview

SOAP samples

ArcWeb site (log in to My Account and click Manage V2 POIs)

Object model