Click an object name to see a description of a SOAP object and its parameters. You might also wish to reference the object model to quickly see how the objects and methods are related to each ArcWeb service.
| AccountInfoOptions | Contains parameters for Account Info Web Service. Input request for Account Info. |
||||
|---|---|---|---|---|---|
| adminOptions:AdminOptions | Determines which user names are returned and whether the group usage is returned. Only available to administrators of ArcWeb accounts. | ||||
| returnDataSources:string[] | Contains a list of data sources about which to return information. See Service Finder for a list of valid data source names. | ||||
| returnDetailInfo:boolean | Determines if information is returned at the data source level rather than the service level. Default value is false. A value of false returns general usage information for the services. | ||||
| returnServices:string[] | Contains a list of ArcWeb services about which to return information. Valid values are "AccountInfo", "AddressFinder", "AddressManager", "Authentication", "ContentFinder", "DataManager", "MapImage", "PlaceFinder", "PlaceFinderSample", "Report", "RouteFinder", "SpatialQuery", "Utility", or "WirelessLocation". Default value is null. | ||||
| Code examples |
|
| AccountSummary | Contains requested usage information about an ArcWeb account. Output from Account Info. |
||||
|---|---|---|---|---|---|
| groupUsage:AccountUsage | Contains usage information for the group. | ||||
| usageByUser:UserUsage[] | Contains usage information for each requested user in a group. Non-administrators can only get information about themselves. | ||||
| Code examples |
|
| AccountUsage | Contains requested information about usage of ArcWeb Services. Output from Account Info. |
||||
|---|---|---|---|---|---|
| averageDailyCreditUsage:double | Contains the daily average credit usage over the period of time requested in the object DateTimeRange. A day is based on Pacific Standard Time. See Account Info notes for more information on credit usage calculations. | ||||
| creditsRemaining:double | Contains the remaining number of credits. | ||||
| creditsUsed:double | Contains the total number of credits used. | ||||
| dailyStorageCost:double | Contains the daily cost (in credits) for storing data on the ArcWeb servers. Daily cost is based a Pacific Standard Time day for current storage usage. | ||||
| diskStorageQuota:long | Contains the total amount (in bytes) of free ArcWeb server space the group account can use. Only returned if AdminOptions.returnGroupUsage is set to true. | ||||
| diskStorageUsed:long | Contains the total amount (in bytes) of ArcWeb server space used to store data. | ||||
| estimatedEndDate:long | Contains the estimated date that you will reach a zero credit balance based on the current credit consumption. Reported in UNIX time. Renew by purchasing more credits. See Account Info notes for more information on credit usage calculations. | ||||
| expiration:long | Contains the expiration date for the ArcWeb account. Reported in UNIX time. The date is calculated as 365 days after the account is activated or renewed. | ||||
| totalStorageCost:double | Contains the total accumulated credit cost for storing data on the ArcWeb servers over the period of time requested in the object DateTimeRange. | ||||
| Code examples |
|
| Address | Contains a definition of the address or intersection. See Address
Finder notes for more information on successful geocoding. Input and output for Address Finder and Address Manager. |
||||
|---|---|---|---|---|---|
| city:string | Contains the city of the address. | ||||
| country:string | Contains the two-letter country code of the address. Use the Address Finder method getInfo or Address Manager method getInfo to see a list and descriptions of the codes. See Geocoding Country Codes for a list of valid country codes. | ||||
| houseNumber:string | Contains the house number of the address. House numbers can also be defined within the street field instead of the houseNumber field. | ||||
| intersection:string | Contains the second street of an intersection address. | ||||
| postalCode:string | Contains the ZIP Code or postal code of the address. | ||||
| stateProvince:string | Contains the state or province of the address. | ||||
| street:string | Contains the street name of the address and can include the house number (optional). | ||||
| Code examples |
|
| AddressFields | Contains field mapping for associated address fields in a data file. Address
fields apply when you use the method geocodeFeatures
to create point geometry for your features. Input request for Data Manager. |
||||
|---|---|---|---|---|---|
| city:string | Contains the name of the field in the data file which stores the city name. | ||||
| country:string | Contains the name of the field in the data file which stores the two-letter country code. | ||||
| houseNumber:string | Contains the name of the field in the data file which stores the house number. House numbers can also be defined within the street field instead of the houseNumber field. | ||||
| intersection:string | Contains the name of the field in the data file which stores the street intersection. | ||||
| postalCode:string | Contains the name of the field in the data file which stores the ZIP Code or postal code. | ||||
| stateProvince:string | Contains the name of the field in the data file which stores the state or province. | ||||
| street:string | Contains the name of the field in the data file which stores the street name and can include the house number (optional). | ||||
| Code examples |
|
| AddressFinderInfo | Contains requested information about a geocoding data source. Output from Address Finder and Address Manager. |
||||
|---|---|---|---|---|---|
| countryCodes:KeyValue[] | Contains a list of countries supported by the data source. The list contains key/value pairs of country code and description. | ||||
| dataSource:string | Contains the name of the geocoding data source about which this object returns information. | ||||
| extendedPostalCode:boolean | Indicates if extended postal codes (for example, zip + 4) are supported by the data source. Extended postal codes apply to forward geocoding (not reverse geocoding) and are only returned for US addresses. | ||||
| partialAddress:boolean | Indicates if partial addresses are supported by the data source. Partial addresses apply to forward geocoding (not reverse geocoding). | ||||
| reverseGeocode:boolean | Indicates if reverse geocoding is supported by the data source. | ||||
| snapTypes:string[] | Contains a list of reverse geocoding snap types supported by the data source. Possible values are "house", "intersection", or "range". House returns the nearest interpolated full street address; intersection returns the nearest intersection; and range returns the nearest street segment address range. Snap types apply to reverse geocoding (not forward geocoding). | ||||
| Code examples |
|
| AddressFinderOptions | Contains parameters for Address Finder Web Service or Address Manager Web
Service. Input request for Address Finder and Address Manager. |
||||
|---|---|---|---|---|---|
| dataSource:string | Contains the name of the data source to use for geocoding. Required. See Address Finder data sources for valid values. (Use the name in parenthesis.) | ||||
| extendedPostalCode:boolean | ArcWeb Services no longer supports extended postal codes. The default value (false) should not be changed. A value of true will not return extended postal codes. | ||||
| partialAddress:boolean | Determines if partial addresses are returned when not enough address information exists in the request. Default value is false. Partial addresses apply to forward geocoding (not reverse geocoding). | ||||
| resultSetRange:ResultSetRange | Contains the range of results to be returned. | ||||
| snapType:string | Contains the reverse geocoding snap types to use with the methods findAddressByPoint (Address Finder) or findAddressesbyPoint (Address Manager). Valid values are "house", "intersection", or "range". House returns the nearest interpolated full street address; intersection returns the nearest intersection; and range returns the nearest street segment address range. Default value is house. Snap types apply to reverse geocoding (not forward geocoding). | ||||
| Code examples |
|
| AddressInfo | Contains requested address information about a location. Output from Address Manager. |
||||
|---|---|---|---|---|---|
| address:Address | Contains address information about a given location. | ||||
| errorMessage:string | Contains an error message related to the geocoding attempt. See SOAP error messages for more information. | ||||
| Code examples |
|
| AdminOptions | Determines which user names are returned and whether the group usage is
returned. Only available to administrators of ArcWeb accounts. Input request for Account Info. |
||||
|---|---|---|---|---|---|
| returnGroupUsage:boolean | Determines if group usage information is returned. Default value is false. | ||||
| returnUsers:string[] | Contains a list of user names about which to return account information. | ||||
| Code examples |
|
| AttributeDesc | Contains metadata fields for a data file, layer, or data source. Output from Content Finder and Data Manager. |
||||
|---|---|---|---|---|---|
| length:integer | Contains the maximum length of the value in a metadata field. | ||||
| name:string | Contains the name of the metadata field. | ||||
| precision:integer | Contains the maximum valid number of digits after the decimal place. | ||||
| required:string | Determines if the metadata field is required. Valid values are "false" or "true". Default value is "true". | ||||
| shortDesc:string | Contains a short description of the metadata field. | ||||
| type:string | Contains the type of feature. Valid values are "date", "double", "integer", or "string". | ||||
| Code examples |
|
| Circle | Contains parameters for a circle. Input request for Map Image and Utility. |
||||
|---|---|---|---|---|---|
| center:Point | Contains the center point of the circle. | ||||
| radius:double | Contains the radius of the circle. | ||||
| radiusUnits:string | Contains the units of the radius. Valid values are "km" (kilometers) or "miles". Default value is "miles". | ||||
| trueCircle:boolean | Determines if the edge of the circle is an equal distance from its center point. Default value is false. If true, the circle is a real circle but on a map with the default coordinate system (4326), it appears as an ellipse due to the unprojected nature of the map. If false, the circle appears round on the map with the default geographic coordinate system (4326) but it is not a true circle because it is only the declared distance from its center point in the east-west direction. | ||||
| Code examples |
|
| CircleDesc | Contains parameters for a circle on a map. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| antialiasing:string | Determines if antialiasing is used to make smoother edges on the circle. Valid values are "false" or "true". Default value is "false". | ||||
| boundaryColor:string | Contains the color of the circle boundary line. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). Default value is "0,0,0" (black). | ||||
| boundaryTransparency:double | Contains the transparency of the circle boundary line. Valid values are between 0.1 (fully transparent) and 1.0 (fully opaque). Default value is "1.0". If you set the value to "0", transparency defaults to "1.0". | ||||
| boundaryType:string | Contains the type of pattern used for the circle boundary line. Valid values are "dash", "dash_dot", "dash_dot_dot", "dot", or "solid". Default value is "solid". | ||||
| circle:Circle | Contains the size and location of the circle. | ||||
| fillColor:string | Contains the fill color of the circle. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). Default value is "0,200,0" (green). | ||||
| fillTransparency:double | Contains the transparency of the circle. Valid values are between 0.1 (fully transparent) and 1.0 (fully opaque). Default value is "1.0". If you set the value to "0", transparency defaults to "1.0". To get 100% transparency, set value to small non-zero number such as "0.000000001". | ||||
| overlapLabels:string | Determines if map labels can overlap the circle. Value values are "false" or "true". Default value is "true". | ||||
| thickness:integer | Contains the thickness of the circle boundary line. The thickness is in pixels. Default value is "1". | ||||
| Code examples |
|
| CircularArc | Contains parameters for a circular arc. Input request for Utility. |
||||
|---|---|---|---|---|---|
| center:Point | Contains the center point of the circle on which the arc is based. | ||||
| endAngle:double | Contains the angle between north (0 degrees) and the ending point of the arc. The angle is in degrees. | ||||
| innerRadius:double | Contains the radius of the arc's inside boundary. | ||||
| outerRadius:double | Contains the radius of the arc's outside boundary. | ||||
| radiusUnits:string | Contains the units of the radius. Valid values are "miles" or "km" (kilometers). Default value is "miles". | ||||
| startAngle:double | Contains the angle between north (0 degrees) and the starting point of the arc. The angle is in degrees. | ||||
| trueCircle:boolean | Determines if the edge of the circle is an equal distance from its center point. Default value is false. If true, the circle is a real circle but on the default coordinate system (4326), it appears as an ellipse due to the unprojected nature of the map. If false, the circle appears round on the default geographic coordinate system (4326) but it is not a true circle because it is only equal distance from its center point in the east-west direction. | ||||
| Code examples |
|
| ContentFinderRecord | Contains requested information about ArcWeb content. Output from Content Finder. |
||||
|---|---|---|---|---|---|
| attributes:KeyValue[] | Contains information (metadata) about the content. | ||||
| contentLastUpdated:long | Contains the date the content was last updated. Reported in UNIX time. | ||||
| contentProperties:KeyValue[] | Contains information about a data files, layers, or data sources. The returned properties depend on the value you set for ContentFinderRecordID.contentType. | ||||
| extent:Envelope | Contains the extent of the content. | ||||
| id:ContentFinderRecordID | Contains the ID of the content record. | ||||
| Code examples |
|
| ContentFinderRecordID | Contains parameters for a content record ID. Input request for Content Finder. |
||||
|---|---|---|---|---|---|
| contentType:string | Contains the type of content. Valid values are "DataFile", "Layer", or "DataSource". | ||||
| name:string | Contains the name of the content. | ||||
| service:string | Contains the type of service. Required when contentType value is "DataSource". Use method getAvailableServices to see a list of valid values for your account. | ||||
| Code examples |
|
| ContentFinderResultSet | Contains a list of records that match the query. Output from Content Finder. |
||||
|---|---|---|---|---|---|
| records:ContentFinderRecord[] | Contains a list of records that meet the given ContentFinderSearchOptions constraints. | ||||
| totalCount:integer | Contains the total number of records. For example, if 50 records match and the count was specified to be 20, the totalCount is 50 even though only 20 records are actually returned. The remaining 30 records can be retrieved in future requests using the object ResultSetRange. | ||||
| Code examples |
|
| ContentFinderSearchOptions | Contains parameters for searching for ArcWeb content. Input request for Content Finder. |
||||
|---|---|---|---|---|---|
| contentType:string | Contains the type of content. Valid values are "DataFile", "Layer", or "DataSource". | ||||
| dataScale:long | Contains the data scale of the data file or layer. Only use the number to the right of map scale colon (for example, in a 1:20000 scale, use "20000"). Not used with contentType "DataSource". | ||||
| dataType:integer | Contains the type of data. Valid values are "0", "1", "2", "3", or "4" . The value 0 = all, 1 = point, 2 = line, 3 = polygon, and 4 = image. Not used with contentType "DataSource". | ||||
| extent:Envelope | Contains the extent of the content. The default value is Envelope:coordinateSystem:"4326", maxx:"180", maxy:"90", minx:"-180", and miny:"90". | ||||
| orderBy:string | Contains the order of the returned values. You can order by attribute, name, extent, content property, contentLastUpdated, or service. Use the method getAvailableAttributes to get valid values. | ||||
| orderDescending:boolean | Determines if the results are returned in ascending or descending order. Default value is false which means ascending order. | ||||
| ownerType:string | Contains the owner type of the content. Valid values are "public", "shared", or "user". Default value is null which returns all types. | ||||
| resultSetRange:ResultSetRange | Contains the range of results to be returned. | ||||
| returnAttributes:string[] | Contains a list of metadata attributes to return. Use the method getAvailableAttributes to get valid values. Default value is "all". | ||||
| returnContentProperties:boolean | Determines if the content properties are returned. See ContentFinderRecord.contentProperties for a list properties. Default value is false. | ||||
| service:string | Contains the type of service. Required when contentType value is "DataSource". Valid values are "AddressFinder", "AddressManager", "Location", "MapImage", "PlaceFinder", "PlaceFinderSample", "Report", "RouteFinder" "SpatialQuery", "Utility". | ||||
| spatialOperator:string | Contains the spatial operator to use when searching by extent. Valid values are "overlaps" or "within". Default value is "overlaps". Not used with extent null. | ||||
| whereClause:string | Contains an SQL WHERE clause to limit search results. The following operators work in a WHERE clause: =, >, >=, <, <=, <>, AND, OR, LIKE, BETWEEN, IN, NOT IN. The following are not valid: ORDER BY and DISTINCT. Invalid WHERE clauses are ignored. Use the method getAvailableAttributes to return the metadata fields you can use to build the WHERE clause. See Building WHERE clauses for more information on WHERE clauses. | ||||
| Code examples |
|
| CoordSys | Contains the coordinate system being used. Default value is projection
"4326" except for New Zealand geocoding which uses "2193"
by default. Input and output for Address Finder, Address Manager, Content Finder, Data Manager, Place Finder, Place Finder Sample, Wireless Location, Map Image, Report, Route Finder, and Utility. |
||||
|---|---|---|---|---|---|
| datumTransformation:string | Contains the conversion of the data between two geographic coordinate systems. See Coordinate systems for valid values. | ||||
| projection:string | Contains the projection of the data. Value can be either a projection string or a projection ID. See Coordinate systems for valid values. | ||||
| Code examples |
|
| CustomReportVariables | Contains available variables for a custom report. Use the method getCustomVariables
to get a list of available variables. Input request for Report. |
||||
|---|---|---|---|---|---|
| variableDataSource:string | Contains the name of the Report data source with the variables. See Report data sources for valid values. | ||||
| variableNames:string[] | Contains the names of variables to use in the custom report. | ||||
| Code examples |
|
| CustomVariableInfo | Contains requested information about a variable to use in a custom report. Output from Report. |
||||
|---|---|---|---|---|---|
| database:string | Contains the name of the database with the variable. | ||||
| fieldDesc:FieldDesc | Contains a description of the field in the variable. | ||||
| Code examples |
|
| DataFile | Contains parameters for creating a data file. Input request for Data Manager. |
||||
|---|---|---|---|---|---|
| addressFields:AddressFields | Establishes field mapping for address fields in the data file. Address fields apply when you use the method geocodeFeatures to create point geometry for your features. | ||||
| attributes:KeyValue[] | Contains metadata for the data file. | ||||
| coordSys:CoordSys | Contains the coordinate system for the data file. | ||||
| fieldsInfo:FieldInfo[] | Contains information about the fields in the data file. A data file can have a maximum of 50 fields per type (date, number, and string). | ||||
| geometryType:string | Contains the type of geometry for the data file. Valid values are "1" for multipoint, "2" for polyline, or "3" for polygon. | ||||
| name:string | Contains the name of the data file. | ||||
| Code examples |
|
| DataFileInfo | Contains requested information about a data file based on input from the
object DataFile. Output from Data Manager. |
||||
|---|---|---|---|---|---|
| dateCreated:long | Contains the date the data file was created. Reported in UNIX time. | ||||
| extent:Envelope | Contains the extent of the data file in native units. | ||||
| featureCount:integer | Contains the number of features in the data file. | ||||
| geographicExtent:Envelope | Contains the geographic extent of the data file in decimal degree units. | ||||
| lastModified:long | Contains the date the data file was last updated. Reported in UNIX time. | ||||
| maxScale:long | Contains the maximum scale of the data file. Only use the number to the right of map scale colon (for example, in a 1:20000 scale, use "20000"). | ||||
| minScale:long | Contains the minimum scale of the data file. Only use the number to the right of map scale colon (for example, in a 1:20000 scale, use "20000"). | ||||
| size:long | Contains the size of the data file. | ||||
| Code examples |
|
| DataSourceInfo | Contains requested information about a data source. Output from Account Info. |
||||
|---|---|---|---|---|---|
| name:string | Contains the name of the data source. | ||||
| summary:string | Contains a summary about the data source content. | ||||
| supportsArcXML:boolean | Determines if the data source is also available using the ArcXML API. Default value is false. | ||||
| supportsWMS:boolean | Determines if the data source is also available using the WMS API. Default value is false. | ||||
| title:string | Contains the short description of the data source | ||||
| size:long | Contains the size in bytes of the data file. | ||||
| Code examples |
|
| DataSourceUsage | Contains requested usage information about a data source used by an ArcWeb
account. Output from Account Info. |
||||
|---|---|---|---|---|---|
| name:string | Contains the name of the data source. | ||||
| title:string | Contains the short description of the data source | ||||
| usage:UsageInfo | Contains usage information about the data source. | ||||
| Code examples |
|
| DateTimeRange | Contains the time for which you want information about your ArcWeb usage.
Input request for Account Info and Wireless Location. |
||||
|---|---|---|---|---|---|
| end:long | Contains the end time period. Valid format is UNIX time. | ||||
| start:long | Contains the beginning time period. Valid format is UNIX time. | ||||
| Code examples |
|
| DeviceLocationInfo | Contains requested information about a mobile device location. Output from Wireless Location. |
||||
|---|---|---|---|---|---|
| accuracy:string | Contains the accuracy of the mobile device location. If you request high accuracy from Sprint and it is not available, Sprint may return low instead. Bell Mobility returns your requested accuracy or throws an error. | ||||
| errorMessage:string | Contains an error message from Wireless Location Web Service. | ||||
| point:Point | Contains the x,y coordinate of the mobile device. | ||||
| radius:double | Contains the radius of the mobile device location. Radius measures the degree of accuracy associated with a device's location. Currently, Sprint does not return the accuracy (returns "0.0" for the radius). | ||||
| timeStamp:long | Contains the time stamp of when the mobile device location was fixed. Time is reported in UNIX time format. | ||||
| Code examples |
|
| DeviceLocationOptions | Contains parameters for Wireless Location Web Service. Input request for Wireless Location. |
||||
|---|---|---|---|---|---|
| accuracy:string | Contains the accuracy for querying the location of the mobile device. Valid values are "low", "high", or the number of meters for the measurement to be within such as "300" (high) or "5000" (low). If you request high accuracy from Sprint and it is not available, Sprint may return low instead. Bell Mobility returns your requested accuracy or throws an error. | ||||
| radiusUnits:string | Contains the units to use in reporting the degree of accuracy associated with a devices location (reported in DeviceLocationInfo.radius). The valid value is "meters". Currently, Sprint does not report the degree of accuracy (returns "0.0" for DeviceLocationInfo.radius). | ||||
| Code examples |
|
| DeviceStatus | Contains information about the on/off state of a mobile device. Output from Wireless Location. |
||||
|---|---|---|---|---|---|
| errorMessage:string | Contains an error message from Wireless Location Web Service. | ||||
| status:string | Contains the status of the mobile device operation. Possible values are "offline", "online", or "unknown". | ||||
| Code examples |
|
| DeviceStopInfo | Contains requested information about a mobile device stop location. Output from Wireless Location. |
||||
|---|---|---|---|---|---|
| point:Point | Contains the center x,y coordinate of the radius that includes all the stops. | ||||
| dateTimeRange:DateTimeRange | Contains the start and end time that the mobile device paused. Reported in UNIX time. | ||||
| Code examples |
|
| DeviceStopOptions | Contains parameters for retrieving the locations of a stopped mobile device. Output from Wireless Location. |
||||
|---|---|---|---|---|---|
| dataFileName:string | Contains the name of the data file with the stored point locations of the mobile device. | ||||
| dateTimeRange:DateTimeRange | Contains the start and end time for retrieving the stops. Valid format is UNIX time. You can control which stops are returned by saving the returned timestamps (from object DeviceLocationInfo) in a data file. Use these timestamps as your values for dataTimeRange. | ||||
| maxRadius:double | Contains the maximum radius for calculating the stop locations. If two or more locations are within this radius, then the radius is considered a stop. | ||||
| minDuration:integer | Contains the minimum time that a device must be stationary for it to be calculated as stopped. Interval is in minutes. | ||||
| radiusUnits:string | Contains the units for the radius of the stops. Valid values are "km" or "miles". Default value is "miles". | ||||
| Code examples |
|
| DeviceTripInfo | Contains requested information about the movement of a mobile device. Output from Wireless Location. |
||||
|---|---|---|---|---|---|
| angle:double | Contains the angle the mobile device traveled. Values represent direction of travel where "0"=north; "90"=east; "180"=south; and "270"=west. | ||||
| distance:double | Contains the total distance of the path the mobile device traveled. Distance is displayed in the units specified in DeviceTripOptions.units. | ||||
| path:Geometry | Contains the line geometry of the mobile device path. | ||||
| speed:integer | Contains the average speed the mobile device traveled. | ||||
| Code examples |
|
| DeviceTripOptions | Contains parameters for analyzing the movement of a mobile device. Input request for Wireless Location. |
||||
|---|---|---|---|---|---|
| dataFileName:string | Contains the name of the data file with the stored point locations of the mobile device. | ||||
| dateTimeRange:DateTimeRange | Contains the start and end time to use for returning trip information. Valid format is UNIX time. | ||||
| returnAngle:boolean | Determines if the direction of travel is returned. Default value is false. | ||||
| returnDistance:boolean | Determines if the total distance is calculated. Default value is false. | ||||
| returnPath:boolean | Determines if the geometry of the path is returned. Default value is false | ||||
| returnSpeed:boolean | Determines if the average speed is returned. Default value is false. Speed is returned as kilometers/hour or miles/hour depending on what you set in units. | ||||
| units:string | Contains the distance units to use with returnSpeed and returnDistance. Possible values are "km" or "miles". Default value is "miles". Speed is returned as kilometers/hour for "km" or miles/hour for "miles". | ||||
| Code examples |
|
| DistanceInfo | Contains requested information about the distance between two points. Output from Utility. |
||||
|---|---|---|---|---|---|
| distance:double | Contains the distance between two points. | ||||
| geometry:Geometry | Contains the line geometry used to measure the distance between the two points. | ||||
| Code examples |
|
| Ellipse | Contains parameters for an ellipse. Input request for Utility. |
||||
|---|---|---|---|---|---|
| axisUnits:string | Contains the units of the axes. Valid values are "miles" or "km" (kilometers). Default value is "miles". | ||||
| center:Point | Contains the center point of the ellipse | ||||
| majorAxis:double | Contains the length of the ellipse's major axis | ||||
| minorAxis:double | Contains the length of the ellipse's minor axis. | ||||
| rotation:double | Contains the rotation angle in degrees of the major axis clockwise away from north. | ||||
| trueEllipse:boolean | Determines if the shape of the ellipse is true, regardless to its appearance on a map. Default value is false. A true ellipse measures the same distance from the center to the north edge as the center to south edge, but different from the east and west edges, which are also the same distance from the center. Default value is false. If true, the ellipse is a true ellipse but on the default coordinate system (4326), its shape appears distorted due to the unprojected nature of the map. If false, the ellipse appears elliptical in shape on the default geographic coordinate system (4326) but it is not a true ellipse because it is only correct in the east-west direction. | ||||
| Code examples |
|
| Envelope | Contains a rectangular feature that can be used as a map extent or as a
bounding box of a feature. If it is used as a bounding box, it contains
the maximum and minimum x,y coordinates of the feature. Input and output for Address Finder, Address Manager, Content Finder, Data Manager, Place Finder, Place Finder Sample, Map Image, Route Finder, and Utility. |
||||
|---|---|---|---|---|---|
| coordSys:CoordSys | Contains the coordinate system of the envelope. Default value is projection "4326". | ||||
| maxX:double | Contains the maximum x coordinate (longitude) of the extent. | ||||
| maxY:double | Contains the maximum y coordinate (latitude) of the extent. | ||||
| minX:double | Contains the minimum x coordinate (longitude) of the extent. | ||||
| minY:double | Contains the minimum y coordinate (latitude) of the extent. | ||||
| Code examples |
|
| Feature | Contains the geometry and attributes of a feature in a data file. Input and output for Data Manager. |
||||
|---|---|---|---|---|---|
| fieldValues:KeyValue[] | Contains attribute information about the feature in a data file. The keys represent the field names and the values represent the field values. | ||||
| geometry:Geometry | Contains the geometry of the feature in a data file. | ||||
| Code examples |
|
| FeatureIDInfo | Contains the unique ID of the feature in a data file. Output from Data Manager. |
||||
|---|---|---|---|---|---|
| errorMessage:string | Contains an error message from Data Manager Web Service. Error messages are returned when Data Manager encounters an error trying to add or update a feature. | ||||
|
id:string |
Contains the unique ID of the feature. |
||||
|
Code examples |
|
| FeatureInfo | Contains requested information about a feature in a data file. Output from Data Manager. |
||||
|---|---|---|---|---|---|
| dateCreated:long | Contains the date the feature was created. Date is in UNIX time. | ||||
| feature:Feature | Contains the geometry and attributes of the feature. | ||||
| geocodeDataSource:string | Contains the name of the Address Finder data source used to geocode the feature. Only applies if the method geocodeFeatures was used to determine a features geometry. | ||||
| geocodeStatus:string | Contains the status of the geocode result, if applicable. Only applies if the method geocodeFeatures was used to determine a features geometry. | ||||
| id:string | Contains the unique ID of the feature. | ||||
| lastModified:long | Contains the date the feature was last updated. Date is in UNIX time. | ||||
| Code examples |
|
| FeatureResultSet | Contains results of a feature search. Output from Data Manager. |
||||
|---|---|---|---|---|---|
| features:FeatureInfo[] | Contains information about the features matching the search criteria. | ||||
| totalCount:integer | Contains the total number features that meet the search criteria. For example, if 50 records match the criteria and ResultSetRange:count is "20", totalCount is "50" even though only 20 records are actually returned to the client. The remaining 30 features can be retrieved in future requests using ResultSetRange. | ||||
| Code examples |
|
| FeatureSearchOptions | Contains parameters for a feature search in a data file. Input request for Data Manager. |
||||
|---|---|---|---|---|---|
| intersectGeometry:Geometry | Contains a geometry. Used to find features that intersect with a specified geometry. Use the parameter spatialBuffer to create a buffer around the specified geometry. | ||||
| returnGeometry:boolean | Determines if the geometry of the feature is returned. Default value is false. | ||||
| searchOptions:SearchOptions | Contains the search options for finding features. | ||||
| spatialBuffer:SpatialBuffer | Contains a buffer zone around a given geometry. Only valid if used with the parameter intersectGeometry. | ||||
| Code examples |
|
| FeatureUpdateOptions | Contains parameters for updating features in a data file. Leave null if
you do not want to update your features. Input request for Data Manager. |
||||
|---|---|---|---|---|---|
| fieldValues:KeyValue[] | Contains the updated field values for the feature. | ||||
| geometry:Geometry | Contains the updated geometry for the feature. | ||||
| Code examples |
|
| FieldDesc | Contains the complete description of the field. By default, all the field
values in RowData are returned as strings. FieldDesc
contains information that is needed to convert the string value back to
its original type. For example, the value of name for Distance is returned
as "12.3". To convert this value to its actual type, use the
values of FieldDesc's length (for example 4), type (for example Float),
and precision (for example 1). Output from Report and Spatial Query. |
||||
|---|---|---|---|---|---|
| length:integer | Contains the actual length of the field. For example, the value "14.7" has a length of "4". The value of the length varies based on the values of type and precision. | ||||
| name:string | Contains the name of the field. | ||||
| precision:integer | Contains the number of digits after the decimal place. It is used with type "float". The values of type "integer" and "string" is "0". | ||||
| shortDesc:string | Contains a short description of the field. The short description corresponds to the alias name in a custom spatial query service. See Building spatial query services for more information. | ||||
| type:string | Contains the data type of the field. Possible values are "integer", "float", or "string". Report Web Service (but not Spatial Query or Utility) can also return "count" (integer), "pct" (integer with "%"), "ratio" (double rounded to one decimal place), or "dollar" (double usually rounded to closest whole number). | ||||
| Code examples |
|
| FieldInfo | Contains information about a field in a data file. A data file can have
a maximum of 50 fields per type. Output from Data Manager. |
||||
|---|---|---|---|---|---|
| isIndexed:boolean | Determines if the field is indexed. Indexing fields improves the performance of WHERE clause queries that include the field. Indexing fields may increase the length of time it takes to update the data file. Each field type can have a maximum of 2 indexed fields. Default value is false. | ||||
| label:string | Contains the label, or alias, for the field. | ||||
| name:string | Contains the name of the field. | ||||
| type:integer | Contains the field type. Valid values are "1" (string), "2" (number) or "3" (date). Dates are stored in UNIX time. | ||||
| Code examples |
|
| GeocodeCandidate | Contains the complete description of a place that matches the search criteria. Output from Address Finder, Address Manager, Data Manager, Place Finder, and Place Finder Sample. |
||||
|---|---|---|---|---|---|
| address:Address | Contains the address or intersection of the place. Addresses are only returned by Address Finder and Address Manager. | ||||
| desc1:string | Contains the scrubbed address (e.g., 380 New York St. Redlands, CA 92373) or long description of the place (e.g., Redlands, California, United States). | ||||
| desc2:string | Contains the short description of the place (e.g., Redlands). Time zones are returned with Address Finder getLocationByPhoneNumber or Address Manager getLocationsByPhoneNumber requests. Only returned with place names. | ||||
| extent:Envelope | Contains the bounding extent of the place. Only returned with place names. | ||||
| matchType:string | Contains the type of match for the address location. See Geocode codes for more information. Used when either an address or a phone number is returned. | ||||
| point:Point | Contains the x,y coordinates and the coordinate system of the place. | ||||
| score:double | Contains a number from 1 to 20 in the form X.X indicating the likelihood of a match to the place, with 1 being the most likely and 20 being the least likely. For convenience, the returned records are sorted by score. Only returned with place names (address score returned as 0.0) | ||||
| type:string | Contains a letter indicating the type of place. See Geocode codes for more information. Only returned with places. | ||||
| Code examples |
|
| GeocodeInfo | Contains information about a geocode request. Output from Address Finder, Address Manager, Data Manager, Place Finder, and Place Finder Sample. |
||||
|---|---|---|---|---|---|
| candidates:GeocodeCandidate[] | Contains the list of places that match the input criteria. | ||||
| errorMessage:string | Contains an error code and description in the case of NOMATCH. Error codes are returned for United States addresses only. See Geocoding codes for more information. Not used in Place Finder or Place Finder Sample. | ||||
| hasMore:boolean | Indicates if there are more records available in the result. The value is "true" if count in ResultSetRange is less than the total number of records. | ||||
| matchType:string | Contains the type of candidate match. The possible values are "CANDIDATES", "ERROR", "EXACT", or "NOMATCH". | ||||
| totalCount:integer | Contains the total number of results that meet the search criteria. | ||||
| Code examples |
|
| GeocodeOptions | Contains parameters for geocoding features the data file. Used with the
method geocodeFeatures. Input request for Data Manager. |
||||
|---|---|---|---|---|---|
| dataSource:string | Contains the name of the data source to use for geocoding the feature. Required. See Address Finder data sources for valid values. (Use the name in parenthesis.) | ||||
| extendedPostalCode:boolean | Determines if extended postal codes (zip + 4) are returned. Default value is false. | ||||
| formatAddressFields:boolean | Determines if the address information is reformatted after geocoding. Default value is false. | ||||
| partialAddress:boolean | Determines if partial addresses are returned. Default value is false. | ||||
| Code examples |
|
| GeographyIDOptions | Contains parameters for finding IDs for a specific geography. Input request for Report. |
||||
|---|---|---|---|---|---|
| geographyIDFilter:string | Contains a geographic filter for limiting the returned IDs. Valid values are "BlockGroup", "CBSA", "Congressional Districts", "County", "County SubDivisions", "DMA", "Place", "State", "Tract", and "Zip". | ||||
| geographyLevelFilter:string | Not currently used; reserved for future versions of ArcWeb Services. | ||||
| keyword:string | Contains a geography name or set of characters (e.g., "Redlands") with two or more characters. The values are case sensitive. | ||||
| outputGeographyLevel:string | Contains the geography level for the IDs. Valid values are "BlockGroup", "CBSA", "Congressional Districts", "County", "County SubDivisions", "DMA", "Place", "State", "Tract", and "Zip". It is required. | ||||
| resultSetRange:ResultSetRange | Contains the range for the returned IDs. Default values are count "20" and startIndex "0". Maximum value for count is 1000. | ||||
| Code examples |
|
| Geometry | Contains information about the shape of a feature. The feature can be a
multipoint, polyline, or polygon. Input and output for Data Manager, Map Image, Report, Route Finder, Utility, and Wireless Location. |
||||
|---|---|---|---|---|---|
| coordSys:CoordSys | Contains the coordinate system of the geometry. Default value is projection "4326". | ||||
| parts:integer[] | Contains the index number of the first point in a feature. If the geometry of a feature is multipart, then each part in the array points to the beginning point of each feature. For example, a set of five points could represent one line (i.e., one part) or multiple lines (i.e., multiple parts). | ||||
| points:SimplePoint[] | Contains the points of the feature. | ||||
| type:integer | Contains the type of geometry. Valid values are "1" for multipoint, "2" for polyline, or "3" for polygon. | ||||
| Code examples |
|
| KeyValue | Contains a keyvalue pair. The key part of the pair contains a short identifier
such as a type or code for retrieving a particular value and the value
part contains a description of the key. Default value is null. Input and output for Content Finder, Data Manager, Place Finder, Place Finder Sample, Map Image, and Report. |
||||
|---|---|---|---|---|---|
| key:string | Contains an identifier such as a type or code for retrieving a value. For example, in the PlaceFinderInfo parameter countryCodes, key contains the country code. Default value is 'null'. | ||||
| value:string | Contains a description of the key value. For example, in the PlaceFinderInfo parameter countryCodes, value contains the name of the country. Default value is 'null' except for Report Web Service. For Report default values and character limits, see Report Web Service notes. | ||||
| Code examples |
|
| LabelDesc | Contains parameters for a label in a map. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| angle:double | Contains the angle of rotation in degrees moving counterclockwise; 0 degrees is horizontal. | ||||
| antialiasing:string | Determines if antialiasing is used to make smoother edges on the label. Valid values are "false" or "true". Default value is "true". If fontStyle is not NULL, antialiasing is "false". | ||||
| blockoutColor:string | Contains the background color behind the label. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). Default value is none (transparent). | ||||
| caps:string | Contains the case format for the label. Valid values are "alllower" (for example arcweb services), "allupper" (for example ARCWEB SERVICES), "titlecaps" (for example, Arcweb Services) or "none" (no change to the label). Default value is "none". | ||||
| font:string | Contains the font of the label. Valid values are "Arial", "Bembo MT", "Book Antiqua", "Bookman Old Style", "Century Gothic", "Courier New", "Georgia", "Gill Sans MT", "Monotype Century Schoolbook", "Rockwell MT", "Symbol", "Tahoma", "Times New Roman", or "Verdana". Default value is "Arial". | ||||
| fontColor:string | Contains the color of the font. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). Default value is "0,0,0" (black). | ||||
| fontSize:integer | Contains the size of the font. Default value is "11". | ||||
| fontStyle:string | Contains the style of the font. Valid values are "bold", "regular", "italic", "underline", "outline", or "bolditalic". Default value is "regular". If fontStyle is not NULL, antialiasing is "false". | ||||
| glowing:boolean | Determines if there is a white glow around the label. Default value is false. | ||||
| hAlignment:string | Contains the horizontal alignment of the label. Valid values are "right", "left", or "center". Default value is "right". | ||||
| interval:integer | Contains the distance in pixels from the marker point. Valid values are positive integers. Default value is "8". | ||||
| outlineColor:string | Contains the outline color of the label. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). Default value is "255,255,255" (white). | ||||
| overlapLabels:string | Determines if the basemap labels can overlap your labels. Valid values are "false" or "true". Default value is "true". | ||||
| transparency:double | Contains the transparency of the label text. It does not affect the text outline. Valid values are between 0.1 (fully transparent) and 1.0 (fully opaque). Default is "1.0". If you set the value to "0", transparency defaults to "1.0". | ||||
| vAlignment:string | Contains the vertical alignment of the label. Valid values are "top", "bottom", or "center". Default value is "top". | ||||
| Code examples |
|
| Layer | Contains parameters for a map layer. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| name:string | Contains the name of the layer. | ||||
| visibility:string | Contains the visibility of the layer. Valid values when used in the object MapImageOptions are "on" or "off". Default maintains the default behavior of the layer, for example, on at certain scales and off at certain scales. A map layer with a visibility value of "on" will not appear at all extents. | ||||
| Code examples |
|
| LayerInfo | Contains requested information about layers in a Map Image data source. Output from Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| legends:LayerLegend[] | Contains the name of the layer class and the URL of the layer class symbol swatch. Use this information to build a custom legend. One LayerLegend per layer class is included in the array. | ||||
| name:string | Contains the name of the layer. | ||||
| visibility:string | Contains the visibility of the layer. Possible values are "default", "not available", or "on". The value "default" indicates the layer is currently not visible, but could be made visible at the current scale. The value "not available" indicates the layer is not visible and cannot be made visible at the current scale due to the layer's minimum and maximum scale settings. The value "on" indicates the layer is currently visible. | ||||
| Code examples |
|
| LayerLegend | Contains requested information about a layer legend. Use this information
to create your own legend. Output from Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| layerClassName:string | Contains the name of the layer class. | ||||
| symbolURL:string | Contains the URL of the layer class symbol swatch. | ||||
| Code examples |
|
| LineDesc | Contains parameters for a line in a map. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| antialiasing:string | Determines if antialiasing is used to make smoother edges on the line. Valid values are "false" or "true". Default value is "false". | ||||
| color:string | Contains the color of the line. Valid format is an R,G,B string with each value between 0 and 255 (for example, "0,200,0" is green). Default value is "255,0,0" (red). | ||||
| endType:string | Contains the style of the end of the line. Valid values are "butt", "round", or "square". Default value is "butt". See Map Image notes for graphic examples of valid values. | ||||
| geometry:Geometry | Contains the geometry of the line. | ||||
| jointType:string | Contains the shape of the line where the line changes direction. Valid values are "bevel", "miter", or "round". Default value is "round". See Map Image notes for graphic examples of valid values. | ||||
| lineType:string | Contains the type of pattern used for the line. Valid values are "dash", "dash_dot", "dash_dot_dot", "dot", or "solid". Default value is "solid". | ||||
| overlapLabels:string | Determines if the map labels can overlap the line. Valid values are "false" or "true". Default values is "true". | ||||
| thickness:integer | Contains the thickness of the line. Value is in pixels. Default value is "1". | ||||
| transparency:double | Contains the transparency of the line. It does not affect the outline. Valid values are between 0.1 (fully transparent) and 1.0 (fully opaque). Default value is "1.0". If you set the value to "0", transparency defaults to "1.0". | ||||
| Code examples |
|
| MapArea | Contains the area to use for the map image. Define the area using either
extent or center and scale both not all three. If all three parameters
are set, only extent is used. Input and output for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| center:Point | Contains the center x,y coordinates of the map area. Requires scale parameter. | ||||
| extent:Envelope | Contains the extent of the map area. | ||||
| scale:long | Contains the scale of the map area. Requires center parameter. Only use the number to the right of map scale colon (for example, in a 1:20000 scale, use "20000"). | ||||
| Code examples |
|
| MapFusionOptions | Contains the URL and transparency of a map to merge with another map. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| mapURL:string | Contains the URL of the map to fuse. The URL must begin with http:// or https://. | ||||
| transparency:double | Contains the transparency of the map. Valid values are between 0.1 (fully transparent) and 1.0 (fully opaque). Default is "0.5". If you set the value to "0", transparency defaults to 0.5. | ||||
| Code examples |
|
| MapImageInfo | Contains requested information about a map. Output from Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| layers:LayerInfo[] | Contains a LayerInfo object for each layer in the data source. Returned if the object MapImageOptions parameter returnLayer is set to "true". | ||||
| legendURL:string | Contains the URL of the map legend. Returned if the object MapImageOptions parameter mapLegend is defined. | ||||
| mapArea:MapArea | Contains the center point, extent, and scale of the map. | ||||
|
mapURL:string |
Contains the URL to access the map. |
||||
|
outputCoordSys:CoordSys |
Contains the coordinate system of the map. |
||||
| Code examples |
|
| MapImageOptions | Contains parameters for creating a map. Input request Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| backgroundColor:string | Contains the background color of the map image. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). Default value is "255,255,255" (white). To set a transparent background, include "transparent:" at the beginning of your R,G,B value (for example, "transparent:255,0,0"). | ||||
| circles:CircleDesc[] | Contains the circles to include in the map. | ||||
| dataSource:string | Contains the name of the data source to use for mapping. Required. See Map Image data sources for valid values. (Use the name in parenthesis.) NOTE: SVG and SWF (Flash) map images support the same data sources as REST mapping. See REST mapping for a list of valid data sources if you set mapImageFormat= "svg" or "swf". | ||||
| displayLayers:Layer[] | Contains the map layers that are visible. The default visible layers on the map image are displayed if displayLayers is not set. NOTE: This functionality is not currently available for SVG or SWF (Flash) maps. | ||||
| lines:LineDesc[] | Contains the line overlay objects to include on the map. | ||||
|
mapImageFormat:string |
Contains the image format of the map. Valid values are "jpg", "gif", "png", "png8", "svg", or "swf" (Flash). Default value is "jpg" for imagery maps and "gif" for road maps. NOTE: SVG and SWF (Flash) maps support the same data sources as REST mapping. See REST mapping for a list of valid data sources to use with SVG and SWF images. | ||||
| mapImageSize:MapImageSize | Contains the height and width of the map. The size is in pixels. | ||||
| mapLegend:MapLegend | Contains information about the legend for the map. | ||||
| markers:MarkerDesc[] | Contains the markers to include in the map. | ||||
| outputCoordSys:CoordSys | Contains the coordinate system of the output map. Default value is the projection of the input map extent or center point. | ||||
| polygons:PolygonDesc[] | Contains the polygons to include in the map. | ||||
| returnLayers:boolean | Determines if LayerInfo objects are returned. Default value is false. | ||||
| scaleBars:ScaleBarDesc[] | Contains the scalebars to include in the map. Set to a null array if you do not want a scalebar on your map. | ||||
| styleSheet:string | Contains the style sheet to apply to the map. Valid values are "classicEuropean",
"coolSteel", "grayScale", "neutral", and
"tangerine". Default value is "neutral". You can use
the following style sheets with these data sources: classicEuropean—ArcWeb:TA.Streets.EU and ArcWeb:TA.Streets.US coolSteel—ArcWeb:TA.Streets.US grayScale—ArcWeb:AND.Roads.World, ArcWeb:TA.Streets.EU, ArcWeb:TA.Streets.NA, and ArcWeb:TA.Streets.US neutral—ArcWeb:AND.Roads.World, ArcWeb:TA.Streets.EU, ArcWeb:TA.Streets.NA, and ArcWeb:TA.Streets.US tangerine—ArcWeb:AND.Roads.World, ArcWeb:TA.Streets.EU, ArcWeb:TA.Streets.NA, and ArcWeb:TA.Streets.US Use Map Image live sample to preview style sheets in a map. |
||||
| Code examples |
|
| MapImageSize | Contains the height and width of the map. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| height:integer | Contains the height of the map. The height is in pixels. The valid values are "1" (minimum) through "1000" (maximum). Maximum value may be lower for a specific data source. Default value is "400". Turn-by-turn routing maps have a default of "200" and a maximum of "300". | ||||
| width:integer | Contains the width of the map. The width is in pixels. The valid values are "1" (minimum) through "1000" (maximum). Maximum value may lower for a specific data source. Default value is "400". The default size is Turn-by-turn routing maps have a default of "200" and a maximum of "300". | ||||
| Code examples |
|
| MapLegend | Contains the parameters for a map legend. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| antialiasing:string | Determines if antialiasing is used to make smoother edges for the labels and symbols. Valid values are "false" or "true". Default value is "true". | ||||
| autoextend:boolean | Determines if the legend automatically extends beyond the size specified in height. Only extended if needed. Default value is false. | ||||
| backgroundColor:string | Contains the background color of the legend. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). Default value is "255,255,255" (white). | ||||
| columns:integer | Contains the number of columns in the legend. Default value is "1". | ||||
| font:string | Contains the font of the legend text. Valid values are "Arial", "Bembo MT", "Book Antiqua", "Bookman Old Style", "Century Gothic", "Courier New", "Georgia", "Gill Sans MT", "Monotype Century Schoolbook", "Rockwell MT", "Tahoma", "Times New Roman", or "Verdana". Default value is "Arial". | ||||
| height:integer | Contains the height of the legend. Height is in pixels. Default value is "300". The height value is ignored if the columns value is greater than "1". (Map Image sets the best height based on the number of columns.) | ||||
| layerFontSize:integer | Contains the size of the font for the legend layer names. Default value is "10". | ||||
| splitText:string | Contains the text that is displayed at the bottom of the column if the contents carries over to the next column. Default is "(cont)". | ||||
| swatchHeight:integer | Contains the height of the symbol swatch in pixels. Default value is "14". | ||||
| swatchWidth:integer | Contains the width of the symbol swatch in pixels. Default value is "18". | ||||
| title: string | Contains the title of the legend. | ||||
| titleFontSize:integer | Contains the size of the font for the legend title. Default value is "12". | ||||
| valueFontSize:integer | Contains the size of the font for the legend values. Default value is "8". | ||||
| width:integer | Contains the width of the legend. Width is in pixels. Default value is "125". | ||||
| Code examples |
|
| MarkerDesc | Contains parameters for markers on the map. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| color:string | Contains the color of the marker. Valid format is an R,G,B string with each value between 0 and 255 (for example, "0,0,0" is black). Default value is "255,0,0" (red). Only used in ArcWeb:ESRI.Simple.Icons (not used in ArcWeb:ESRI.Raster.Icons or ArcWeb:User.Defined.Icons). | ||||
| iconDataSource:string | Contains the name of the icon service. Valid values are "ArcWeb:ESRI.Raster.Icons", "ArcWeb:ESRI.Simple.Icons", or "ArcWeb:User.Defined.Icons". See ArcWeb map icons for a preview of the simple and raster icons. Use the Map Image method getMarkerNames for the most complete list of icons for each data source. SVG and SWF (Flash) maps use REST icons. See ArcWeb map icons for valid icons to use with SVG and SWF images. NOTE: You can use null if you wish to add a label without a marker. | ||||
| label:string | Contains a label for the marker, for example "MyStore". | ||||
| labelDesc:LabelDesc | Contains information about the marker label. To add a label without an icon, define the iconDataSource value as null. | ||||
| location:Point | Contains the x,y location of the marker. | ||||
| name:string | Contains the name of the marker. See ArcWeb map icons for a table of valid marker names. NOTE: SVG and SWF (Flash) maps use REST icons. See ArcWeb map icons for valid icons to use with SVG and SWF images. | ||||
| size:integer | Contains the size, in pixels, of the simple marker. Default value is "10". Only valid with iconDataSource ArcWeb:ESRI.Simple.Icons. | ||||
| Code examples |
|
| MobileDevice | Contains the network provider and ID number for a mobile device. Used to
uniquely identify the device. Input request for Wireless Location. |
||||
|---|---|---|---|---|---|
| dataSource:string | Contains the name of the data source to use for locating a mobile device. Required. See Wireless Location data sources for valid values. (Use the name in parenthesis.) | ||||
| phoneNumber:string | Contains the ID of the mobile device. The valid format depends on the dataSource value, for example 909-793-2853 or 9097932853 (ArcWeb:Sprint_CDMA.Location.US). | ||||
| Code examples |
|
| OrderBy | Contains the order of the attribute queries. Input request for Data Manager and Spatial Query. |
||||
|---|---|---|---|---|---|
| descending:boolean | Determines if the results are sorted in ascending or descending order. Default value is false which means ascending order. | ||||
| field:string | Contains the name of the field to use for sorting. | ||||
| Code examples |
|
| PixelCoord | Contains the location of a point on a map. The location is in pixels. Input and output for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| x:integer | Contains the x coordinate on the map. The x coordinate is in pixels. | ||||
| y:integer | Contains the y coordinate on the map. The y coordinate is in pixels. | ||||
| Code examples |
|
| PlaceFinderInfo | Contains requested information about a find-a-place data source. Output from Place Finder and Place Finder Sample. |
||||
|---|---|---|---|---|---|
| countryCodes:KeyValue[] | Contains the possible countries in this data source used for the search in PlaceFinderOptions:filterCountry. See Geocoding Country Codes for a list of valid country codes. | ||||
| dataSource:string | Contains the name the data source used to find a place. | ||||
| types:KeyValue[] | Contains the possible place types in this data source used for the search in PlaceFinderOptions:filterType. | ||||
| Code examples |
|
| PlaceFinderOptions | Contains parameters for Place Finder and Place Finder Sample Web Services. Input request for Place Finder and Place Finder Sample. |
||||
|---|---|---|---|---|---|
| dataSource:string | Contains the name of the data source to use for finding a place. Required. See Place Finder data sources for valid values. (Use the name in parenthesis.) | ||||
| filterCountry:string | Contains a country, dependency, or area of special sovereignty to search. Use the method getInfo for a list of possible values. Default value is null which searches the whole world. See Geocoding Country Codes for a list of valid country codes. | ||||
| filterExtent:Envelope | Contains the geographic area to search. The default value is null which means no area restrictions. | ||||
| filterType:string | Contains a the type of place to search. See Place type ID codes for a list of valid values. To choose multiple filters, separate place types with commas and no spaces (for example, "A,B,C"). Default value is null which returns all types. | ||||
| resultSetRange:ResultSetRange | Contains the range for the returned place names. The default values are record "20" and startIndex "0". | ||||
| searchType:string | Contains the type of search to perform. Valid values are "startsWith" or "exactMatch". The default is is "startsWith". | ||||
| Code examples |
|
| Point | Contains the x,y coordinates of the point. Input and output for Address Finder, Address Manager, Data Manager, Place Finder, Place Finder Sample, Wireless Location, Map Image, Report, Route Finder, and Utility. |
||||
|---|---|---|---|---|---|
| coordSys:CoordSys | Contains the coordinate system of the point. | ||||
| x:double | Contains the x coordinate of the point. | ||||
| y:double | Contains the y coordinate of the point. | ||||
| Code examples |
|
| PolygonDesc | Contains parameters for a polygon on a map. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| antialiasing:string | Determines if antialiasing is used to make smoother edges on the polygon. Valid values are "false" or "true". Default value is "true". | ||||
| boundary:string | Determines if the polygon has an boundary line. Valid values are "false" or "true". Default value is "true". | ||||
| boundaryColor:string | Contains the color of the polygon boundary. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). Default value is "0,0,0" (black). | ||||
| boundaryJointType:string | Contains the shape of the line where the line changes direction. Valid values are "bevel", "miter", or "round". Default value is "round". | ||||
| boundaryTransparency:double | Contains the transparency of the polygon outline. Valid values are between 0.1 (fully transparent) and 1.0 (fully opaque). Default value is "0.0". If you set the value above "1.0", you receive an error message. | ||||
| boundaryType:string | Contains the type of pattern used for the polygon boundary line. Valid values are "dash", "dash_dot", "dash_dot_dot", "dot", or "solid". Default value is "solid". | ||||
| boundaryWidth:integer | Contains the thickness of the polygon boundary line. Thickness is in pixels. Default value is "1". | ||||
| fillColor:string | Contains color of the polygon fill. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). The default value is "0,200,0" (green). | ||||
| fillInterval:integer | Contains the distance in pixels between the lines for hatch fills. Hatch fills are used when fillType value is "bdiagonal", "cross", "diagcross", "fdiagonal", "horizontal", or "vertical". Default value is "6". | ||||
| fillTransparency:double | Contains the transparency of the fill. Valid values are between 0.1 (fully transparent) and 1.0 (fully opaque). Default value is "0.0". If you set the value above "1.0", you receive an error message. To get 100% transparency, set value to small non-zero number such as "0.000000001". | ||||
| fillType:string | Contains the type of pattern of the polygon fill. Valid values are "bdiagonal", "cross", "diagcross", "fdiagonal", "horizontal", "solid", and "vertical". The default value is "solid". | ||||
| geometry:Geometry | Contains the geometry of the polygon. | ||||
| overlapLabels:string | Determines if basemap labels can overlap the polygon. Value values are "false" or "true". Default value is "true". | ||||
| Code examples |
|
| ReportInfo | Contains requested information about the service, format, and URL of a
report. Output from Report. |
||||
|---|---|---|---|---|---|
| dataSource:string | Contains the name of the data source used for creating a report. | ||||
| reportFormat:string | Contains the format of the report. | ||||
| reportURL:string | Contains the URL to access the report. | ||||
| Code examples |
|
| ReportOptions | Contains parameters for Report Web Service. Input request for Report. |
||||
|---|---|---|---|---|---|
| dataSource:string | Contains the name of the data source to use for creating a report. Required. See Report data sources for valid values. (Use the name in parenthesis.) | ||||
| reportFormat:string | Contains the format of the report. Valid values are "excel", "pdf", or "xml". Default value is "pdf". | ||||
| reportHeader:KeyValue[] | Contains the key/value pairs for the header of a report. Default value is null. Use the method getReportHeaderKeys or see Report notes for a list of key names and value descriptions. If you leave a value empty, the corresponding key item does not appear in your report. | ||||
| Code examples |
|
| ResultSet | Contains a table of data results from a request. The fields parameter contains
information about the table's columns. The rows parameter contains the
actual data. Output from Report and Spatial Query. |
||||
|---|---|---|---|---|---|
| fields:FieldDesc[] | Contains an array of fields. | ||||
| rows:RowData[] | Contains an array of row data. | ||||
| totalCount:integer | Contains the total number of results that meet the search criteria. For example, if 50 records match the criteria and ResultSetRange:count is "20", totalCount is "50" even though only 20 records are actually returned to the client. The remaining 30 records can be retrieved in future requests using the object ResultSetRange. | ||||
| Code examples |
|
| ResultSetRange | Contains the range for returned records based on the startIndex and count
values. Output from Address Finder, Place Finder, Place Finder Sample, Report, and Spatial Query. |
||||
|---|---|---|---|---|---|
| count:integer | Contains the number of records that are returned in the results. The default value is "20". Each data source has a maximum count. For most data sources, the maximum count is "1000" but some are less. Value cannot exceed "1000". | ||||
| startIndex:integer | Contains the number of records to skip in the query. The first record is always 0. For example, to get records 11-15, set startIndex to "10". The default value is "0". | ||||
| Code examples |
|
| RouteDisplayOptions | Contains parameters for how a route is displayed on a map. Input request for Route Finder. |
||||
|---|---|---|---|---|---|
| color:string | Contains the color of the route line. Valid format is an R,G,B string with each value between 0 and 255 (for example, "0,0,0" is black). The default value is "255,0,0" (red). | ||||
| thickness:integer | Contains the thickness of the route line. Thickness is in pixels. Valid values are greater than or equal to "1". Default value is "7". | ||||
| transparency:double | Contains the transparency of the route line. Valid values are between 0.1 (fully transparent) and 1.0 (fully opaque). The default value is "0.5". If you set the value to "0", transparency defaults to "0.5". If you set the value above "1.0", you receive an error message. | ||||
| Code examples |
|
| RouteFinderOptions | Contains parameters for using Route Finder Web Service. Input request for Route Finder. |
||||
|---|---|---|---|---|---|
| avoidTraffic:boolean | Determines if current traffic conditions are considered when generating a route. Default value is false. If value is set to true, trafficDataSource must also be set. | ||||
| dataSource:string | Contains the name of the data source to use for routing. Required. See Route Finder data sources for valid values. (Use the name in parenthesis.) | ||||
| language:string | Contains the language used in the route description. Valid values are "danish", "dutch", "english", "french", "german", "italian", "norwegian", "portuguese", "spanish", or "swedish". The default value is "english". | ||||
| returnDirections:boolean | Determines if a description of the route is returned. The default value is false. If returnDirections, returnGeometry, and returnMap are false, only the total description of the route is returned (from RouteInfo:totalDesc). | ||||
| returnGeometry:boolean | Determines if the geometry of the route is returned. The default value is false. If returnDirections, returnGeometry, and returnMap are false, only the total description of the route is returned (from RouteInfo:totalDesc). | ||||
| returnMap:boolean | Determines if map image of the route is returned. The default value is false. If returnDirections, returnGeometry, and returnMap are false, only the total description of the route is returned (from RouteInfo:totalDesc). If you set returnMap to true, you are charged for the cost of the map. | ||||
| returnTurnByTurnMaps:boolean | Determines if turn-by-turn maps are returned. Turn-by-turn maps are a series of small zoomed-in maps detailing where route segments meet. The first turn-by-turn map corresponds to the second SegmentDesc object. The default value is false. If you set returnTurnByTurnMaps to true, you are charged for the cost of each map. | ||||
| routeDisplayOptions:RouteDisplayOptions | Contains parameters for how the route is displayed on a map. For routeDisplayOptions to take effect, returnMap must be set to "true". | ||||
| routeMapOptions:MapImageOptions | Contains the parameters for a map image of the route. | ||||
| routeOptions:RouteOptions | Contains the parameters for the route. | ||||
| trafficDataSource:string | Contains the name of the traffic data source used to create traffic barriers. Required if avoidTraffic is set to true. Valid value is "ArcWeb:TC.Traffic.US". See Route Finder notes for information on using custom barriers. | ||||
| trafficSeverity:integer | Contains the traffic incident severity ratings to avoid. Valid values are "1" (severe), "2" (high), "3" (medium), or "4" (low). Traffic incidents at and above the set severity are avoided in a route, for example, "2" avoids high and severe incidents. Default value is "0" which avoids all incidents. | ||||
| turnByTurnMapOptions:MapImageOptions | Contains the parameters for turn-by-turn maps. The default map image is 200x200 and the maximum size is 300x300. | ||||
| units:string | Contains the units of the route. Valid values are "km" (kilometers) or "miles". The default value is "miles". | ||||
| Code examples |
|
| RouteInfo | Contains requested information about a route. Output from Route Finder. |
||||
|---|---|---|---|---|---|
| optimizedStopOrder:integer[] | Contains the order by which the stops were optimized. The array of stops matches the array of stops in the object RouteStop. | ||||
| routeMap:MapImageInfo | Contains the URL, legend (if requested), and extent of a route map. A map of a route is only returned if RouteFinderOptions:returnMap is "true". | ||||
| routePath:Geometry | Contains the geometry of the route. The geometry is only returned if RouteFinderOptions:returnGeometry is set to "true". | ||||
| segmentDescs:SegmentDesc[] | Contains an array of descriptions about each segment of the route. Descriptions are only returned if RouteFinderOptions:returnDirections is set to "true". | ||||
| totalDesc:RouteSummary | Contains the total route time and distance. | ||||
| turnByTurnMaps:MapImageInfo[] | Contains the URL, legends (if requested), and extents of the turn-by-turn maps. Turn-by-turn maps are only returned if RouteFinderOptions:returnTurnByTurnMaps is set to "true". | ||||
| Code examples |
|
| RouteOptions | Contains the parameters of a route. Input request for Route Finder. |
||||
|---|---|---|---|---|---|
| filterExtent:Envelope | Contains the extent for the returned map (does not affect the route). It is useful if only part of the route needs to be displayed in a map. | ||||
| hwyPref:integer | Contains the preference for using highways. Valid values are between "1" and "100". The value of "1" means to avoid highways if possible, and the value of "100" means to use highways as much as possible. Default value is "80". If you set the value to "0", hwyPref defaults to "80". hwyPref is not used with routeType "shortest". | ||||
| optimizeStops:boolean | Determines if intermediate waypoints are reordered to optimize for distance. Default value is false. Not considered if request contains less than four (4) RouteStop objects. | ||||
| precision:double | Contains the minimum distance between points on a route in decimal degrees (i.e., it sets the shape generalization of the route). Useful for minimizing the response time. The default value is "0.0", which means no generalization. Reasonable values are 0.001 and 0.000000001. The larger the value (higher precision/more generalization), the more generalized the shape (and the faster the response time). If a map image is requested, precision is ignored and the route is generalized to the resolution of the map. | ||||
| returnExtents:boolean | Determines if an extent is returned for each segment in the route. Default value is false. | ||||
| routeBarriers:Point[] | Contains the locations of the route barrier or barriers. The route does not pass through any of these points. | ||||
| routeType:string | Contains the route searching criteria for using either the quickest or shortest route. Valid values are "quickest" or "shortest". Quickest returns a route based on the shortest time to travel between stops. Shortest returns a route based on the shortest distance to travel between stops. Default value is "quickest". When using "shortest", hwyPref is not considered. | ||||
| Code examples |
|
| RouteStop | Contains a stop along a route. Output from Route Finder. |
||||
|---|---|---|---|---|---|
| desc:string | Contains the name of the stop. The name appears in the driving directions and is used to refer to the specific route stop. | ||||
| point:Point | Contains the x,y coordinate of the stop. The route geometry is output as projection 4326 regardless of the coordinate system on the input points. | ||||
| Code examples |
|
| RouteSummary | Contains requested information about driving directions for a route. Output from Route Finder. |
||||
|---|---|---|---|---|---|
| distanceUnits:string | Contains the units of the route distance. The possible values are "km" (kilometers) or "miles". | ||||
| numericDistance:double | Contains the total length of the route. Distance is rounded to two decimal places. | ||||
| numericTime:double | Contains the estimated minutes the route takes to drive. Time is rounded to whole minutes. | ||||
| routeExtent:Envelope | Contains the extent of the route. | ||||
| totalDistance:string | Contains a description of the length of the route for example, "Driving distance: 2.8 mile(s)". Distance is rounded to one decimal place. | ||||
| totalTime:string | Contains a description of the estimated time the route takes to drive for example, "Driving time: 22 minute(s)". Time is rounded to whole minutes. | ||||
| Code examples |
|
| RowData | Contains a single row of data. Output from Spatial Query. |
||||
|---|---|---|---|---|---|
| fieldValues:string[] | Contains values for each of the fields in ResultSet.field
FieldDesc array. For example, if there are four elements in FieldDesc[]
then each row contains a string array of four field values: fieldValue[0] corresponds to this row's value for the column named FieldDesc[0] fieldValue[1] corresponds to this row's value for the column named FieldDesc[1] fieldValue[2] corresponds to this row's value for the column named FieldDesc[2] fieldValue[3] corresponds to this row's value for the column named FieldDesc[3] |
||||
| Code examples |
|
| ScaleBarDesc | Contains parameters for the scale bar on the map. Input request for Map Image and Route Finder. |
||||
|---|---|---|---|---|---|
| barColor:string | Contains the color of the scale bar. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). Default value is "0,0,0" (black). | ||||
| barLength:integer | Contains the length of the scale bar. Length is in pixels. The default length of the scale bar is 25% of the map width. | ||||
| barPixelLocation:PixelCoord | Contains the location of the scale bar on the map. Default value is (0,13). Note: The copyright text may obscure the scale bar if the scale bar is located at small x and y values. | ||||
| barUnits:string | Contains the units for the scale bar. Valid values are "km" (kilometers) or "miles". Default value is "miles". | ||||
| barWidth:integer | Contains the width of the scale bar. Width is in pixels. Default value is "5". | ||||
| font:string | Contains the font for the scale bar number values. Valid values are "Arial", "Bembo MT", "Book Antiqua", "Bookman Old Style", "Century Gothic", "Courier New", "Georgia", "Gill Sans MT", "Monotype Century Schoolbook", "Rockwell MT", "Tahoma", "Times New Roman", or "Verdana". Default value is "Arial". | ||||
| fontColor:string | Contains the color of the font. Color style is defined as an R,G,B string with each value between 0 and 255, for example, ("255,0,0") is red. Default value is "0,0,0" (black). | ||||
| fontSize:integer | Contains the size of the scale bar font. Default value is "11". | ||||
| Code examples |
|
| SearchOptions | Contains parameters for a search. Input request for Data Manager and Spatial Query. |
||||
|---|---|---|---|---|---|
| orderByList:OrderBy[] | Contains a field value to use for sorting the results of records that are of equal distances (0.0). Currently, only one value is valid (an array of more than one value returns an error). | ||||
| resultSetRange:ResultSetRange | Contains the range of results to be returned. | ||||
| returnFields:string[] | Contains the field names to be returned. List the field names in the order you would like them displayed. For Spatial Query, use the method getAvailableFieldNames to see possible fields. By default, all the fields associated with a given data source are returned. | ||||
| whereClause:string | Contains a SQL WHERE clause to limit search results. The following operators work in a WHERE clause: =, >, >=, <, <=, <>, AND, OR, LIKE, BETWEEN, IN, NOT IN. The following are not valid: ORDER BY and DISTINCT. Invalid WHERE clauses are ignored. See Building WHERE clauses for more information on WHERE clauses. | ||||
| Code examples |
|
| SegmentDesc | Contains requested descriptions for each segment of a route. Each segment
can have multiple lines of description. SegmentDesc is null if the object
RouteStop parameter desc is null. Output from Route Finder. |
||||
|---|---|---|---|---|---|
| descriptiveDirections:string | Contains a description of the route segment, for example, "Turn left on W Redlands Blvd". Value is null if SegmentDesc is a route stop. | ||||
| descriptiveDistance:string | Contains a descriptive distance of the route segment, for example, "Driving distance: 2.8 mile(s)". Distance is rounded to one decimal place. | ||||
| extent:Envelope | Contains the extent of the route segment. | ||||
| numericDistance:double | Contains the distance of the route segment for example "2.85". Distance is rounded to two decimal places. Value is "0.0" if SegmentDesc is a route stop. | ||||
| numericTime:double | Contains the estimated minutes the route segment takes to drive. Time is rounded to whole minutes. Value is "0" if SegmentDesc is a route stop. | ||||
| Code examples |
|
| ServiceInfo | Contains requested information about an ArcWeb service. Output from Account Info. |
||||
|---|---|---|---|---|---|
| dataSourcesInfo:DataSourceInfo[] | Contains information about the available data sources for the ArcWeb service. | ||||
| desc:string | Contains a short description of the ArcWeb service. | ||||
| name:string | Contains the name of the ArcWeb service. | ||||
| wsdl:string | Contains the WSDL location of the ArcWeb service. | ||||
| Code examples |
|
| ServiceSummary | Contains requested information about the available ArcWeb services to an
ArcWeb user. Output from Account Info. |
||||
|---|---|---|---|---|---|
| servicesInfo:ServiceInfo[] | Contains information about the ArcWeb services available to the user. | ||||
| user:User | Contains information about the user. | ||||
| Code examples |
|
| ServiceUsage | Contains requested usage information about an ArcWeb service. Output from Account Info. |
||||
|---|---|---|---|---|---|
| dataSourcesUsage:DataSourceUsage[] | Contains information about the data sources used by the ArcWeb service. | ||||
| name:string | Contains the name of the ArcWeb service. | ||||
| usage:UsageInfo | Contains information about how much the ArcWeb service has been used. | ||||
| Code examples |
|
| SimplePoint | Contains the x,y coordinate of the point. Input and output for Data Manager, Wireless Location, Map Image, Report, Route Finder, and Utility. |
||||
|---|---|---|---|---|---|
| x:double | Contains the x coordinate of the point. | ||||
| y:double | Contains the y coordinate of the point. | ||||
| Code examples |
|
| Site | Contains the area of the report. Input request for Report. |
||||
|---|---|---|---|---|---|
| calcType:string | Contains the type of rings. Valid values are "solid" or "hollow". Default value is "solid". Used with the methods getCustomSiteReport and getSiteReports. | ||||
| polygons:Geometry[] | Contains the areas for the report. The report can contain polygons or ringRadii but not both. | ||||
| ringRadii:double[] | Contains the radii of the rings. The report can contain ringRadii or polygons but not both. | ||||
| ringUnits:string | Contains the units for the ring's radius. Valid values are "km" (kilometers) or "miles". Default value is "miles". | ||||
| siteLocation:Point | Contains the x,y coordinates of the site. Used to define either the center of the rings or a reference point for the polygons (it does not define the geometry of the polygons). | ||||
| siteName:string | Contains site name. On site reports, the site name appears as the header of the report. On site map reports, the site name appears as the label for the point (site) on the map. | ||||
| Code examples |
|
| SpatialBuffer | Contains the size of the zone around an input geometry in which to search
for results. Input request for Data Manager and Spatial Query. |
||||
|---|---|---|---|---|---|
| bufferDistance:double | Contains the distance of the buffer zone as measured from the edge of the input geometry (point, line, or polygon). The default value is "none". To search only within your input polygon, set the value to almost 0 (for example, "0.000001"). | ||||
| bufferUnits:string | Contains the units for the buffer zone. Valid values are "km" (kilometers) or "miles". Default value is "miles". | ||||
| Code examples |
|
| SpatialQueryInfo | Contains available fields from a specific spatial query data source. Output from Spatial Query. |
||||
|---|---|---|---|---|---|
| availableFields:FieldDesc[] | Contains descriptions of query fields in the spatial query data source. | ||||
| dataSource:string | Contains the name of the spatial query data source. | ||||
| Code examples |
|
| SpatialQueryOptions | Contains parameters for Spatial Query Web Service. Input request for Spatial Query. |
||||
|---|---|---|---|---|---|
| dataSource:string | Contains the name of the data source to use for spatial querying. Required. See Spatial Query data sources for valid values. (Use the name in parenthesis.) | ||||
| distanceUnits:string | Contains the units used to measure the distance from the input search point or geometry to individual results from the spatial query data source. Valid values are "km" (kilometers) or "miles". The default value is "miles". | ||||
| returnDistance:boolean | Determines if the distances are returned from the input search geometry to the individual results from the spatial query data source. Default value is false. | ||||
| returnGeometry:boolean | Determines if the latitude and longitude values are returned. Default value is false. Only valid for feature searches on points. | ||||
| searchOptions:SearchOptions | Contains parameters for the search results. | ||||
| spatialBuffer:SpatialBuffer | Contains a zone in which to search for results. | ||||
| Code examples |
|
| StandardGeography | Contains the standard geography of the site area for the report. Input request for Report. |
||||
|---|---|---|---|---|---|
| geographyIDs:string[] | Contains the geographic ID for the site. Required. Use the method getGeographyIDs to get valid values. | ||||
| geographyLevel:string | Contains the geographic level at which the data is returned. Required. Valid values are "cbsa", "county", "dma", "place", "state", "tract", or "zip". | ||||
| Code examples |
|
| StringSet | Contains the requested values from a data file attribute. Output from Data Manager. |
||||
|---|---|---|---|---|---|
| strings:string[] | Contains the unique attribute values from a data file. | ||||
| totalcount:integer | Contains the total number of records. For example, if 50 records match and the count was specified to be 20, the totalCount is 50 even though only 20 records are actually returned. The remaining 30 records can be retrieved in future requests using the object ResultSetRange. | ||||
| Code examples |
|
| ThematicColors | Contains thematic color settings used to generate a thematic map. Use either
classColors or colorPalette but not both. If both parameter are set, classColors
takes precedence. Input request for Map Image. |
||||
|---|---|---|---|---|---|
| classColors:string[] | Contains an array of RGB color values. These values must match up ThematicData:data values | ||||
| colorPalette:string | Contains a color ramp for the class breaks. Possible values are "blue", "coldToHot", "green", "grey", "orange", or "red". Default value is "red". | ||||
| Code examples |
|
| ThematicData | Contains data and legend information for a custom thematic map. Use with
the methods getCustomThematicMap
and getValueMap. Input request for Map Image. |
||||
|---|---|---|---|---|---|
| data:KeyValue[] | Contains key/value pairs for geographic FIPS codes and values. When used in the method getCustomThematicMap, the value parameter corresponds to the data itself. When used in the method getValueMap, the value parameter corresponds to the key parameter of input codeColorValues:KeyValue. | ||||
| precision:integer | Contains the number of digits after the decimal place to display for the data values. Used in the map legend. The range of valid values are between "0" and "5". The value of integer and string data is "0". | ||||
| sign:string | Contains the symbol to apply to the thematic data values, for example, "dollar" or "percent". Used in the map legend. | ||||
| Code examples |
|
| ThematicOptions | Contains parameters for creating a thematic map. Input request for Map Image. |
||||
|---|---|---|---|---|---|
| classificationMethod:string | Contains information about how the thematic data classes are divided. Valid values are "equalInterval" or "quantile". Default value is "equalInterval". Equal interval divides the number of classes into equal intervals, regardless of how many members each class contains. Quantile divides the number of classes so each class contains the same number of members, regardless of the interval range. classificationMethod is ignored if you use codeColorValues. NOTE: Ranges are "lower <= value < upper", meaning that if a range says "2-3" it includes records with "2", but not "3". | ||||
| classLabels:string[] | Contains labels for each class in the legend. The order of the classLabels values needs to match up with the order of the legend. | ||||
| numClasses:integer | Contains the number of classes into which the data is classified. Valid values are "2", "3", "4", or "5". Default value is "2". | ||||
| thematicOnlyLegend:boolean | Determines if only the thematic layers are shown in the legend. Default value is false (meaning all map layers appear in the legend). | ||||
| Code examples |
|
| ThematicReportOptions | Contains parameters for a thematic map report. Input request for Report. |
||||
|---|---|---|---|---|---|
| classificationMethod:string | Contains information about how the data classes are divided. Valid values are "equalInterval" or "quantile". Default value is "equalInterval". Equal interval divides the number of classes into equal intervals, regardless of how many members each class contains. Quantile divides the number of classes so each class contains the same number of members, regardless of the interval range. | ||||
| colorPalette:string | Contains a color ramp for the class breaks. Valid values are "blue", "coolToWarm", "coldToHot", green", "grey", "orange", or "red". Default value is "red". | ||||
| geographyLevel:string | Contains the geographic level in which the map report displays. Valid values are "blockgroup", "county", "state", "tract", or "zip". Default value is the most detailed geography level for the given extent. | ||||
| numClasses:integer | Contains the number of classes into which the data is classified. Valid values are "2", "3", "4", or "5". Default value is "2". | ||||
| Code examples |
|
| ThematicVariableInfo | Contains requested information about a variable in a Report Web Service
database. Output from Report. |
||||
|---|---|---|---|---|---|
| database:string | Contains the name of the database containing the variable. | ||||
| shortDesc:string | Contains a short description of the variable. | ||||
| table:string | Contains the name of the table containing the variable. | ||||
| variable:string | Contains the name of the variable. | ||||
| Code examples |
|
| UsageInfo | Contains usage information about an ArcWeb service. Output from AccountInfo. |
||||
|---|---|---|---|---|---|
| creditsUsed:double | Contains the number of credits used for an ArcWeb service and related data sources. | ||||
| dateLastUsed:long | Contains the most recent day the service was used. Reported in UNIX time. | ||||
| numRequests:long | Contains the number of requests made to an ArcWeb service. | ||||
| Code examples |
|
| User | Contains requested information about an ArcWeb user. Output from AccountInfo. |
||||
|---|---|---|---|---|---|
| emailAddress:string | Contains the email address of the user. | ||||
| firstName:string | Contains the first name of the user. | ||||
| isActive:boolean | Indicates if the user has an active ArcWeb account. Inactive users cannot access ArcWeb Services, even if they have remaining credits. Default value is false. | ||||
| isAdmin:boolean | Indicates if the user has administrative privileges for group. Default value is false. | ||||
| lastName:string | Contains the last name of the user. | ||||
| username:string | Contains the username of the user. | ||||
| Code examples |
|
| UserUsage | Contains requested usage information for an ArcWeb user. Output from AccountInfo. |
||||
|---|---|---|---|---|---|
| accountUsage:AccountUsage | Contains usage information about the user. | ||||
| serviceUsage:ServiceUsage[] | Contains usage information about the ArcWeb services used by the user. | ||||
| user:User | Contains information about the user. | ||||
| Code examples |
|
Visit the Feedback page to give comments or suggestions about the ArcWeb Developer's Guide.