ArcWeb Services methods list

For method descriptions, click a method name below. For a diagram of ArcWeb Services methods and objects, see Object model.


Account Info

getAvailableDataSources(group:string, service:string, token:string):DataSource[]

getDataSourceInfo
(dataSource:string, token:string):DataSourceInfo

getDataSourceInfo
(group:string, dataSource:string, token:string):DataSourceInfo

getDataSourcesInfo
(group:string, token:string):DataSourceInfo[]

getGroupInfo
(group:string, token:string):GroupInfo

getGroupsInfo
(token:string):GroupInfo[]

getServiceDataSourceInfo
(service:string, dataSource:string, token:string):ServiceDataSourceInfo

getServiceDataSourceInfo
(group:string, service:string, dataSource:string, token:string):ServiceDataSourceInfo

getServicesDataSourcesInfo
(group:string, token:string):ServiceDataSourceInfo[]

getServiceInfo
(service:string, token:string):ServiceInfo

getServiceInfo
(group:string, service:string, token:string):ServiceInfo

getServicesInfo
(group:string, token:string):ServiceInfo[]

getUserInfo
(token:string):UserInfo

getVersion
:string


Address Finder

findAddress(address:Address, addressFinderOptions:AddressFinderOptions, token:string):LocationInfo

getAddress
(point:Point, addressFinderOptions:AddressFinderOptions, token:string):Address

getCountries
(dataSource:string, token:string):string[]

getVersion
:string


Address Manager

findAddresses(addresses:Address[], addressManagerOptions:AddressManagerOptions, token:string):AddressManagerInfo

getCountries
(dataSource:string, token:string):string[]

getVersion
:string


Authentication

getToken(username:string, password:string):string

getToken
(username:string, password:string, expiration:integer):string

getVersion
:string

validateToken
(token:string):integer


Map Image

convertMapCoordToPixelCoord(viewExtent:Envelope, mapImageSize:MapImageSize, mapCoord:Point):PixelCoord

convertPixelCoordToMapCoord
(viewExtent:Envelope, mapImageSize:MapImageSize, mapClickPoint:PixelCoord):Point

getBestMap
(mapImageOptions:MapImageOptions, token:string):MapImageInfo

getBestMapEnvelope
(mapImageOptions:MapImageOptions):Envelope

getLayerInfo
(dataSource:string):Layer[]

getLayerInfoForExtent
(dataSource:string, mapImageSize:MapImageSize, mapExtent:Envelope):Layer[]

getMap
(mapExtent:Envelope, mapImageOptions:MapImageOptions, token:string):MapImageInfo

getMarkerNames
(iconDataSource:string):string[]

getMyMarkerNames
(iconDataSource:string, token:string):string[]

getThematicFields
(thematicDataSource:string):string[]

getThematicGeographiesForExtent
(thematicDataSource:string, mapImageSize:MapImageSize, mapExtent:Envelope):string[]

getThematicMap
(mapExtent:Envelope, mapImageOptions:MapImageOptions, thematicField:string, thematicOptions:ThematicOptions, token:string):MapImageInfo

getThematicMap
(mapExtent:Envelope, mapImageOptions:MapImageOptions, thematicData:KeyValue[], thematicOptions:ThematicOptions, token:string):MapImageInfo

getVersion
:string


Place Finder

findPlace(placeName:string, placeFinderOptions:PlaceFinderOptions, token:string):LocationInfo

getCountryCodes
(dataSource:string, token:string):KeyValue[]

getTypes
(dataSource:string, token:string):KeyValue[]

getVersion
:string


Place Finder Sample

findPlace(placeName:string, placeFinderOptions:PlaceFinderOptions):LocationInfo

getCountryCodes
:KeyValue[]

getTypes
:KeyValue[]

getVersion
:string


POI Manager

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


Proximity

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


Query

envelopeQuery(envelope:Envelope, queryOptions:QueryOptions, token:string):ResultSet

geometryQuery
(geometry:Geometry, queryOptions:QueryOptions, token:string):ResultSet

getAvailableFieldNames
(queryOptions:QueryOptions):FieldDesc[]

getVersion
:string

pointQuery
(point:Point, queryOptions:QueryOptions, token:string):ResultSet


Report

getAvailableFieldNames:(reportOptions:ReportOptions):FieldDesc[]

getDatabases
:string[]

getGeographyIds
(geographyIdOptions:GeographyIdOptions):ResultSet

getMapReport
(sites:Site[], reportOptions:ReportOptions, token:string):ReportInfo

getReportHeaderKeys
:(methodName:string):KeyValue[]

getSiteReports
(site:Site, reportOptions:ReportOptions[], combineReports:boolean, token:string):ReportInfo[]

getStandardGeographyReport
(standardGeographies:StandardGeography[], reportOptions:ReportOptions, token:string):ReportInfo

getTables
(database:string):string[]

getThematicMapReport
(sites:Site[], reportOptions:ReportOptions, thematicReportOptions:ThematicReportOptions, thematicVariable:string, token:string):ReportInfo

getThematicVariables
(database:string, table:string):ThematicVariableInfo[]

getVersion
:string

searchThematicVariables
(keyword:string): ThematicVariableInfo[]


Route Finder

findRoute(routeStops:RouteStop[], routeFinderOptions:RouteFinderOptions, token:string):RouteInfo

getLanguages
:string[]

getVersion
:string


Utility

getProjectedEnvelope(geometry:Geometry, toCoordSys:CoordinateSystem, token:String):Envelope

getVersion
:String

projectEnvelope
(envelope:Envelope, toCoordSys:CoordinateSystem, token: String):Envelope

projectGeometry
(geometry:Geometry, toCoordSys:CoordinateSystem, token: String):Geometry

projectPoint
(point:Point, toCoordSys:CoordinateSystem, token:String):Point