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 |