Object descriptions

Address

LabelDescription

PolygonDescription

Service

AddressFinderOptions

Layer

ProximityOptions

ServiceDataSourceInfo

AddressManagerInfo

LineDescription

QueryOptions

ServiceInfo

AddressManagerOptions

Location

QueryParams

SimplePoint

CircleDescription

LocationInfo

ReportInfo

Site

CoordinateSystem

MapImageInfo

ReportOptions

StandardGeography

DataSource

MapImageOptions

ResultSet

ThematicOptions

DataSourceInfo

MapImageSize

ResultSetRange

ThematicReportOptions

Envelope

MarkerDescription

RouteDisplayOptions

ThematicVariableInfo

FieldDesc

PixelCoord

RouteFinderOptions

UsageStats

Geometry

PlaceFinderOptions

RouteInfo

UserInfo

GeographyIdOptions

Poi

RouteOptions

Group

PoiManagerOptions

RouteStop

GroupInfo

Point

RowData

KeyValue

PoiResultSet

SegDescription

Address {

Address contains a definition of the address or intersection.

city: string

city contains the city of the address.

country: string

country contains the two-letter country code of the address. It is optional.

houseNumber: string

houseNumber contains the house number of the address. House number can also be defined within the street field instead of houseNumber field.

intersection: string

intersection contains the street intersection of the address.

state_prov: string

state_prov contains the state or province of the address.

street: string

street contains the street name of the address and can include the house number (optional).

zone: string

zone contains the ZIP Code or postal code of the address.

}

Example (Java)

Address definition for the address to be located

Address myAddress = new Address();
myAddress.houseNumber = "380";
myAddress.street = "New York St";
myAddress.city = "Redlands";
myAddress.state_prov = "CA";
myAddress.zone = "92373";

Address definition for the intersection to be located

Address myAddress = new Address();
myAddress.street = "New York St";
myAddress.intersection = "Pine Ave";
myAddress.city = "Redlands";
myAddress.state_prov = "CA";
myAddress.zone = "92373";

Example (VB.NET)

Address definition for the address to be located

Dim myAddress As New Address()
myAddress.houseNumber = "380"
myAddress.street = "New York St"
myAddress.city = "Redlands"
myAddress.state_prov = "CA"
myAddress.zone = "92373"

Address definition for the intersection to be located

Dim myAddress As New Address()
myAddress.street = "New York St"
myAddress.intersection = "Pine Ave"
myAddress.city = "Redlands"
myAddress.state_prov = "CA"
myAddress.zone = "92373"

Example (C#.NET)

Address definition for the address to be located

Address myAddress = new Address();
myAddress.houseNumber = "380";
myAddress.street = "New York St";
myAddress.city = "Redlands";
myAddress.state_prov = "CA";
myAddress.zone = "92373";

Address definition for the intersection to be located

Address myAddress = new Address();
myAddress.street = "New York St";
myAddress.intersection = "Pine Ave";
myAddress.city = "Redlands";
myAddress.state_prov="CA"
myAddress.zone="92373";

AddressFinderOptions {

AddressFinderOptions contains parameters for using Address Finder Web Service.

dataSource: string

dataSource contains the name of the data source used by Address Finder. It is required. See Data sources and credits for a list of possible values.

}

Example (Java)

AddressFinderOptions myAddressFinderOptions = new AddressFinderOptions();
myAddressFinderOptions.dataSource = "GDT.Streets.US";

Example (VB.NET)

Dim myAddressFinderOptions As New AddressFinderOptions() myAddressFinderOptions.dataSource = "GDT.Streets.US"

Example (C#.NET)

AddressFinderOptions myAddressFinderOptions = new AddressFinderOptions();
myAddressFinderOptions.dataSource = "GDT.Streets.US";

AddressManagerInfo {

AddressManagerOptions contains geocoding results.

numCandidateMatches: integer

numCandidateMatches contains the number of  addresses that returned multiple matches.

numSuccessful: integer

numSuccessful contains the number of successful geocodes.

numUnsuccessful: integer

numUnsuccessful contains the number of unsuccessful geocodes.

results: LocationInfo[]

results contains the results of the address geocodes.

}

Example (Java)

IAddressManager myAddressManager = AddressManagerHelper.bind();
Address[] myAddresses = new Address[1] ;
myAddresses[0] = myAddress;
AddressManagerInfo myAddressManagerInfo = myAddressManager.findAddresses(myAddresses, myAddressManagerOptions, token);
System.out.println("Number of Successful geocodes: " + myAddressManagerInfo.numSuccessful);
System.out.println("Number of Unsuccessful geocodes: " + myAddressManagerInfo.numUnsuccessful);
System.out.println("Number of Candidate matches: " + myAddressManagerInfo.numCandidateMatches);

For token, see getToken.

For myAddressManagerOptions, see AddressManagerOptions.

For myAddress, see Address.

Example (VB.NET)

Dim myAddressManager As New AddressManager()
Dim myAddressManagerInfo As New AddressManagerInfo()
myAddressManagerInfo = myAddressManager.findAddresses(myAddresses, myAddressManagerOptions, token)
Console.WriteLine("Number of Successful geocodes: " & myAddressManagerInfo.numSuccessful)
Console.WriteLine("Number of Unsuccessful geocodes: " & myAddressManagerInfo.numUnsuccessful)
Console.WriteLine("Number of Candidate matches: " & myAddressManagerInfo.numCandidateMatches)

For token, see getToken.

For myAddressManagerOptions, see AddressManagerOptions.

For myAddress, see Address.

Example (C#.NET)

AddressManager myAddressManager = new AddressManager();
Address[] myAddresses = new Address[1];
myAddresses[0] = myAddress;
AddressManagerInfo myAddressManagerInfo = myAddressManager.findAddresses(myAddresses, myAddressManagerOptions, token);
Console.WriteLine("Number of Successful geocodes: " + myAddressManagerInfo.numSuccessful);
Console.WriteLine("Number of Unsuccessful geocodes: " + myAddressManagerInfo.numUnsuccessful);
Console.WriteLine("Number of Candidate matches: " + myAddressManagerInfo.numCandidateMatches);

For token, see getToken.

For myAddressManagerOptions, see AddressManagerOptions.

For myAddress, see Address.

AddressManagerOptions {

AddressManagerOptions contains parameters for using Address Manager Web Service.

dataSource: string

dataSource contains the name of the data source used by Address Manager. It is required. See Data sources and credits for a list of possible values.

}

Example (Java)

AddressManagerOptions myAddressManagerOptions = new AddressManagerOptions();
myAddressManagerOptions.dataSource = "TA.Address.US";

Example (VB.NET)

Dim myAddressManagerOptions As New AddressManagerOptions() myAddressManagerOptions.dataSource = "TA.Address.US"

Example (C#.NET)

AddressManagerOptions myAddressManagerOptions = new AddressManagerOptions();
myAddressManagerOptions.dataSource = "TA.Address.US";

CircleDescription {

boundaryColor: string

center: Point

center contains the center of the circle.

radius: double

radius contains the radius of the circle.

radiusUnits: string

}

Example (Java)

Point myCirclePoint = new Point();
myCirclePoint.x = -117.199577;
myCirclePoint.y = 34.048364;

CircleDescription myCircleDescription = new CircleDescription();
myCircleDescription.center = myCirclePoint;
myCircleDescription.radius = 0.150;
myCircleDescription.radiusUnits = "Km";
myCircleDescription.boundaryColor = "0,0,255";

Example (VB.NET)

Dim myCirclepoint As New Point()
myCirclepoint.x = -117.199577
myCirclepoint.y = 34.048364

Dim mycircleDescription As New CircleDescription() mycircleDescription.center = myCirclepoint
mycircleDescription.radius = 0.150
mycircleDescription.radiusUnits = "km" mycircleDescription.boundaryColor = "0,0,255"

Example (C#.NET)

Point myCirclePoint = new Point();
myCirclePoint.x = -117.199577;
myCirclePoint.y = 34.048364;

CircleDescription myCircleDescription = new CircleDescription();
myCircleDescription.center = myCirclePoint;
myCircleDescription.radius = 0.150;
myCircleDescription.radiusUnits ="km";
myCircleDescription.boundaryColor = "0,0,255";

DataSource {

desc:string

desc contains a description of the data source.

name:string

name contains the name of the data source.

shortDesc: string

shortDesc contains a short description of the data source.

}

Example (Java)

IAccountInfo myAccountInfo = AccountInfoHelper.bind();
UserInfo myUserInfo = myAccountInfo.getUserInfo(token);
DataSource[] myDataSources = myUserInfo.dataSources;
for (int i = 0; i < myDataSources.length; i++) {
System.out.println(myDataSources[i].name + "- " + myDataSources[i].desc);
}

Example (VB.NET)

Dim myAccountInfo As New AccountInfo()
Dim myUserInfo As New UserInfo()
Dim myDataSources() As DataSource
Dim i As Integer
myUserInfo = myAccountInfo.getUserInfo(token)
myDataSources = myUserInfo.dataSources
For i = 0 to (myDataSources.Length - 1)
Console.WriteLine(myDataSources(i).name & "- " & myDataSources(i).desc)
Next

Example (C#.NET)

AccountInfo myAccountInfo = new AccountInfo();
UserInfo myUserInfo = new UserInfo();
int i;
myUserInfo = myAccountInfo.getUserInfo(token);
DataSource[] myDataSources = myUserInfo.dataSources;
for (i = 0 ; i < myDataSources.Length; i++)
{
Console.WriteLine(myDataSources[i].name + "- " + myDataSources[i].desc);
}

FieldDesc {

fieldLength: integer

fieldLength contains the actual length of the field. For example, "14.7" has a fieldLength of "4". The value of the length varies based on the fieldType and fieldPrecision.

fieldName: string

fieldName contains the name of the field.

fieldPrecision: integer

fieldShortDesc: string

fieldType: string

}

Example (Java)

FieldDesc in Proximity

IProximity myProximity = ProximityHelper.bind();
FieldDesc[] myFieldDesc = myProximity.getAvailableFieldNames(myProximityOptions);
System.out.println("Field Name of first fieldDesc : " + myFieldDesc[0].fieldName);
System.out.println("Field Short Description of first fieldDesc : " + myFieldDesc[0].fieldShortDesc);
System.out.println("Field Length of first fieldDesc : " + myFieldDesc[0].fieldLength);
System.out.println("Field Precision of first fieldDesc : " + myFieldDesc[0].fieldPrecision);
System.out.println("Field Type of first fieldDesc : " + myFieldDesc[0].fieldType);

FieldDesc in Query

IQuery myQuery = QueryHelper.bind();
FieldDesc[] myFieldDesc = myQuery.getAvailableFieldNames(myQueryOptions);
System.out.println("Field Name of first fieldDesc : " + myFieldDesc[0].fieldName);
System.out.println("Field Short Description of first fieldDesc : " + myFieldDesc[0].fieldShortDesc);
System.out.println("Field Length of first fieldDesc : " + myFieldDesc[0].fieldLength);
System.out.println("Field Precision of first fieldDesc : " + myFieldDesc[0].fieldPrecision);
System.out.println("Field Type of first fieldDesc : " + myFieldDesc[0].fieldType);

FieldDesc in Report

IReport myReport = ReportHelper.bind();

FieldDesc[] myFieldDesc = myReport.getAvailableFieldNames(myReportOptions);
System.out.println("Field Name of first fieldDesc : " + myFieldDesc[0].fieldName);
System.out.println("Field Short Description of first fieldDesc : " + myFieldDesc[0].fieldShortDesc);
System.out.println("Field Length of first fieldDesc : " + myFieldDesc[0].fieldLength);
System.out.println("Field Precision of first fieldDesc : " + myFieldDesc[0].fieldPrecision);
System.out.println("Field Type of first fieldDesc : " + myFieldDesc[0].fieldType);

For myQueryOptions, see QueryOptions.

For myProximityOptions, see ProximityOptions.

For myReportOptions, see ReportOptions.

Example (VB.NET)

FieldDesc in Proximity

Dim myProximity As New Proximity()
Dim myFieldDesc As FieldDesc()
myFieldDesc = myProximity.getAvailableFieldNames(myProximityOptions)

Console.WriteLine("Field Name of first fieldDesc : " & myFieldDesc(0).fieldName)
Console.WriteLine("Field Short Description of first fieldDesc : " + myFieldDesc(0).fieldShortDesc)
Console.WriteLine("Field Length of first fieldDesc : " & myFieldDesc(0).fieldLength)
Console.WriteLine("Field Precision of first fieldDesc : " & myFieldDesc(0).fieldPrecision)
Console.WriteLine("Field Type of first fieldDesc : " & myFieldDesc(0).fieldType)

FieldDesc in Query

Dim myQuery As New Query()
Dim myFieldDesc As FieldDesc()
myFieldDesc = myQuery.getAvailableFieldNames(myQueryOptions)
Console.WriteLine("Field Name of first fieldDesc : " & myFieldDesc(0).fieldName)
Console.WriteLine("Field Short Description of first fieldDesc : " & myFieldDesc(0).fieldShortDesc)
Console.WriteLine("Field Length of first fieldDesc : " & myFieldDesc(0).fieldLength)
Console.WriteLine("Field Precision of first fieldDesc : " & myFieldDesc(0).fieldPrecision)
Console.WriteLine("Field Type of first fieldDesc : " & myFieldDesc(0).fieldType)

FieldDesc in Report

Dim myReport As New Report()
Dim myFieldDesc As FieldDesc()
myFieldDesc = myReport.getAvailableFieldNames(myReportOptions)
Console.WriteLine("Field Name of first fieldDesc : " & myFieldDesc(0).fieldName)
Console.WriteLine("Field Short Description of first fieldDesc : " + myFieldDesc(0).fieldShortDesc)
Console.WriteLine("Field Length of first fieldDesc : " & myFieldDesc(0).fieldLength)
Console.WriteLine("Field Precision of first fieldDesc : " & myFieldDesc(0).fieldPrecision)
Console.WriteLine("Field Type of first fieldDesc : " & myFieldDesc(0).fieldType)

For myQueryOptions, see QueryOptions.

For myProximityOptions, see ProximityOptions.

For myReportOptions, see ReportOptions.

Example (C#.NET)

FieldDesc in Proximity

Proximity myProximity = new Proximity();
FieldDesc[] myFieldDesc = myProximity.getAvailableFieldNames(myProximityOptions);
Console.WriteLine("Field Name of first fieldDesc : " + myFieldDesc[0].fieldName);
Console.WriteLine("Field Short Description of first fieldDesc : " + myFieldDesc[0].fieldShortDesc);
Console.WriteLine("Field Length of first fieldDesc : " + myFieldDesc[0].fieldLength);
Console.WriteLine("Field Precision of first fieldDesc : " + myFieldDesc[0].fieldPrecision);
Console.WriteLine("Field Type of first fieldDesc : " + myFieldDesc[0].fieldType);

FieldDesc in Query

Query myQuery = new Query();
FieldDesc[] myFieldDesc = myQuery.getAvailableFieldNames(myQueryOptions);
Console.WriteLine("Field Name of first fieldDesc : " + myFieldDesc[0].fieldName);
Console.WriteLine("Field Short Description of first fieldDesc : " + myFieldDesc[0].fieldShortDesc);
Console.WriteLine("Field Length of first fieldDesc : " + myFieldDesc[0].fieldLength);
Console.WriteLine("Field Precision of first fieldDesc : " + myFieldDesc[0].fieldPrecision);
Console.WriteLine("Field Type of first fieldDesc : " + myFieldDesc[0].fieldType);

FieldDesc in Report

Report myReport = new Report();
FieldDesc[] myFieldDesc = myReport.getAvailableFieldNames(myReportOptions);
Console.WriteLine("Field Name of first fieldDesc : " + myFieldDesc[0].fieldName);
Console.WriteLine("Field Short Description of first fieldDesc : " + myFieldDesc[0].fieldShortDesc);
Console.WriteLine("Field Length of first fieldDesc : " + myFieldDesc[0].fieldLength);
Console.WriteLine("Field Precision of first fieldDesc : " + myFieldDesc[0].fieldPrecision);
Console.WriteLine("Field Type of first fieldDesc : " + myFieldDesc[0].fieldType);

For myQueryOptions, see QueryOptions.

For myProximityOptions, see ProximityOptions.

For myReportOptions, see ReportOptions.

Geometry {

coordinateSystem: CoordinateSystem

coordinateSystem contains the coordinate system of the geometry.  Default value is projection "4326".

parts: integer[]

parts contains the number and beginning point of a feature. If the Geometry 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 parts) or multiple lines (i.e., multiple parts).

points: SimplePoint[]

points contains the points of the feature.

type: integer

type contains the type of geometry. Value can be "2" for polyline, or "3" for polygon.

}

Example (Java)

Geometry myGeometry = new Geometry();
SimplePoint[] myPoints = new SimplePoint[2];
SimplePoint myPoint1 = new SimplePoint();
SimplePoint myPoint2 = new SimplePoint();
myPoint1.x = -117.199577;
myPoint1.y = 34.048364;
myPoint2.x = -117.179577;
myPoint2.y = 34.018364 ;
myPoints[0] = myPoint1;
myPoints[1] = myPoint2;
myGeometry.points = myPoints;
int[] myParts = new int[1];
myParts[0] = 0;
myGeometry.parts = myParts;
myGeometry.type = 2;
myGeometry.coordinateSystem = myCoordinateSystem ;

Example (VB.NET)

Dim myGeometry As New Geometry()
Dim myPoint1 As New SimplePoint()
Dim myPoint2 As New SimplePoint()
Dim myPoints(1) As SimplePoint
Dim myParts(0) As Integer
myPoint1.x = -117.199577
myPoint1.y = 34.048364
myPoint2.x = -117.179577
myPoint2.y = 34.018364
For i = 0 To (myPoints.Length - 1)
myPoints(i) = New SimplePoint()
Next
myPoints(0) = myPoint1
myPoints(1) = myPoint2
myGeometry.points = myPoints
myParts(0) = 0
myGeometry.parts = myParts
myGeometry.type = 2
myGeometry.coordinateSystem = myCoordinateSystem

Example (C#.NET)

myGeometry = new Geometry();
myPoint1 = new SimplePoint();
myPoint2 = new SimplePoint();
SimplePoint[] myPoints = new SimplePoint[2];
int[] myParts = new int[1];
myPoint1.x = -117.199577;
myPoint1.y = 34.048364;
myPoint2.x = -117.179577;
myPoint2.y = 34.018364 ;
for (i=0;i<myPoints.Length;i++)
myPoints[i]=new SimplePoint ();
myPoints[0] = myPoint1;
myPoints[1] = myPoint2;
myGeometry.points = myPoints;
myParts[0] = 0;
myGeometry.parts = myParts;
myGeometry.type = 2;
myGeometry.coordinateSystem = myCoordinateSystem;

GeographyIdOptions {

keyword contains a geography name or set of characters (e.g., "Redlands") with two or more characters. Note: The values are case sensitive.

outputGeographyLevel 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.

geographyIdFilter contains a geographic filter for limiting the returned IDs.

resultSetRange contains the range for the returned IDs. Default values are count "20" and startIndex "0". Maximum value for count is 1000.

}

GeographyIdOptions myGeographyIdOptions = new GeographyIdOptions();
myGeographyIdOptions.keyword = "Redlands";
myGeographyIdOptions.geographyIdFilter = "06";
myGeographyIdOptions.outputGeographyLevel = "Zip";
myGeographyIdOptions.resultSetRange = myResultSetRange;

Dim myGeographyIdOptions As New GeographyIdOptions()
myGeographyIdOptions.keyword = "Redlands"
myGeographyIdOptions.geographyIdFilter = "06"
myGeographyIdOptions.outputGeographyLevel = "Zip"
myGeographyIdOptions.resultSetRange = myResultSetRange

GeographyIdOptions myGeographyIdOptions = new GeographyIdOptions();
myGeographyIdOptions.keyword = "Redlands";
myGeographyIdOptions.geographyIdFilter = "06";
myGeographyIdOptions.outputGeographyLevel = "Zip";
myGeographyIdOptions.resultSetRange = myResultSetRange;

Group {

desc: string

desc contains a description of the ArcWeb Services group.

name: string

name contains the name of the ArcWeb Services group.

services: Service[]

services contains information about the ArcWeb Services within an ArcWeb Service group.

}

Example (Java)

IAccountInfo myAccountInfo = AccountInfoHelper.bind();
UserInfo myUserInfo = myAccountInfo.getUserInfo(token);

Group[] myGroups = myUserInfo.groups;
for (int i = 0; i < myGroups.length; i++) {
System.out.println(myGroups[i].name + "- " + myGroups[i].desc);
Service[] myServices = myGroups[i].services;

System.out.println("Available Services:");
for (int j = 0; j < myServices.length; j++)    {
System.out.println(" " + myServices[i].name + "- " + yServices[j].desc);
System.out.println(" " + myServices[i].type + "- " + myServices[j].accessUrl);
}
}

Example (VB.NET)

Dim myAccountInfo As New AccountInfo()
Dim myUserInfo As New UserInfo()
Dim myGroups() As Group
Dim myServices() As Service
Dim i As Integer
Dim j As Integer
myUserInfo = myAccountInfo.getUserInfo(token)
myGroups = myUserInfo.groups
For i = 0 to (myGroups.Length - 1)
Console.WriteLine(myGroups(i).name & "- " & myGroups(i).desc)
myServices = myGroups(i).services
Console.WriteLine("Available Services:")
For j = 0 to (myServices.Length - 1)
Console.WriteLine(" " & myServices(j).name & "- " & myServices(j).desc)
Console.WriteLine("" & myServices(j).type & "- " & myServices(j).accessUrl)
Next
Next

Example (C#.NET)

AccountInfo myAccountInfo = new AccountInfo();
UserInfo myUserInfo = new UserInfo();
int i;
int j;
myUserInfo = myAccountInfo.getUserInfo(token);
Group[] myGroups = myUserInfo.groups;
for (i = 0; i < myGroups.Length; i++)
{
Console.WriteLine(myGroups[i].name + "- " + myGroups[i].desc);
Service[] myServices = myGroups[i].services;
Console.WriteLine("Available Services:");
for (j = 0; j < myServices.Length; j++)
{
Console.WriteLine(" " + myServices[i].name + "- " & myServices[j].desc);
Console.WriteLine(" " + myServices[i].type + "- " +
myServices[j].accessUrl);
}
}

GroupInfo {

group: string

group contains the name of the ArcWeb Services group.

stats: UsageStats

stats contains information about the ArcWeb Services group.

}

Example (Java)

IAccountInfo myAccountInfo = AccountInfoHelper.bind();
GroupInfo myGroupInfo = myAccountInfo.getGroupInfo("ArcWebForDev", token);
System.out.println("Group: " + myGroupInfo.group);
System.out.println("Usage: " + myGroupInfo.stats.usage);

Example (VB.NET)

Dim myAccountInfo As New AccountInfo()
Dim myGroupInfo As New GroupInfo()
myGroupInfo = myAccountInfo.getGroupInfo("ArcWebForDev", token)
Console.WriteLine("Group: " & myGroupInfo.group)
Console.WriteLine("Usage: " & myGroupInfo.stats.usage.ToString())

Example (C#.NET)

AccountInfo myAccountInfo = new AccountInfo();
UserInfo myUserInfo = new UserInfo();
int i;
int j;
myUserInfo = myAccountInfo.getUserInfo(token);
Group[] myGroups = myUserInfo.groups;
for (i = 0; i < myGroups.Length; i++)
{
Console.WriteLine(myGroups[i].name + "- " + myGroups[i].desc);
Service[] myServices = myGroups[i].services;
Console.WriteLine("Available Services:");
for (j = 0; j < myServices.Length; j++)
{
Console.WriteLine(" " + myServices[i].name + "- " + myServices[j].desc);
Console.WriteLine(" " + myServices[i].type + "- " +
myServices[j].accessUrl);
}
}

KeyValue {

key: string

key contains an identifier such as a type or code for retrieving a value. For example, in getCountryCodes, key contains the country code. Default value is 'null'.

value: string

value contains a description of the key value. For example, in getCountryCodes, 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.

}

Example (Java)

KeyValue in Map Image

KeyValue myThematicData[] = new KeyValue[2];

KeyValue ky1 = new KeyValue();
ky1.Key = 92373; //zipcode 1
ky1.Value =  100 ;
KeyValue ky2 = new KeyValue();
Ky2.Key = 92375; //zipcode 2
Ky2.Value =  200 ;

KeyValue in Place Finder and Place Finder Sample

int i;
KeyValue[] myKeyValues = myPlaceFinder.getTypes("ESRI.Gazetteer.World",token);
for (i = 0; i < myKeyValues.length; i++)  {
System.out.println(myKeyValues[i]);
}

KeyValue in Report

KeyValue myReportHeader[] = new KeyValue[2];
KeyValue ky1 = new KeyValue();
ky1.key = "address1";
ky1.value = "380 New York Street";
KeyValue ky2 = new KeyValue();
Ky2.key = "address2";
Ky2.value = "Redlands, CA 92373";
myReportHeader[0] = ky1;
myReportHeader[1] = ky2;

Example (VB.NET)

KeyValue for Map Image

Dim myThematicData(1) As KeyValue
Dim ky1 As New KeyValue()
Dim ky2 As New KeyValue()
ky1.Key = "92373" 'zipcode 1
ky1.Value = "100"
ky2.Key = "92375" 'zipcode 2
ky2.Value = "200"
myThematicData(0) = ky1
myThematicData(1) = ky2

KeyValue for Place Finder and Place Finder Sample

dim myKeyValues() as KeyValue
myKeyValues = myPlaceFinder.getTypes("ESRI.Gazetteer.World", token)
For i = 0 to (myKeyValues.Length - 1)
Console.WriteLine("Key: " & myKeyValues(i).Key)
Console.WriteLine("Value: " & myKeyValues(i).Value)
Next

KeyValue for Report

Dim myReportHeader(1) as KeyValue
Dim ky1 As New KeyValue()
Dim ky2 As New KeyValue()
ky1.Key = "address1"
ky1.Value = "380 New York Street"
ky2.Key = "address2"
ky2.Value = "Redlands, CA 92373"
myReportHeader(0) = ky1
myReportHeader(1) = ky2

Example (C#.NET)

KeyValue for Map Image

KeyValue myThematicData[] = new KeyValue[2];

KeyValue ky1 = new KeyValue();

ky1.Key = "92373"; //zipcode 1
ky1.Value = "100";
KeyValue ky2 = new KeyValue();
Ky2.Key = "92375"; //zipcode 2
Ky2.Value = "200";
myThematicData[0] = ky1;
myThematicData[1] = ky2;

KeyValue for Place Finder and Place Finder Sample

int i;
KeyValue[] myKeyValues = myPlaceFinder.getTypes("ESRI.Gazetteer.World",token);
for (i = 0; i < myKeyValues.Length; i++)
{
Console.WriteLine(myKeyValues[i])
}

KeyValue for Report

KeyValue myReportHeader[] = new KeyValue[2];
KeyValue ky1 = new KeyValue();
ky1.key = "address1";
ky1.value = "380 New York Street";
KeyValue ky2 = new KeyValue();
Ky2.key = "address2";
Ky2.value = "Redlands, CA 92373";
myReportHeader[0] = ky1;
myReportHeader[1] = ky2;

LabelDescription {

antialiasing: string

antialiasing determines whether or not antialiasingused to make edges of labels and symbols smoother is active. Possible values are "true" or "false". Default value is "true". If fontStyle is not NULL, antialiasing is "false".

font: string

font contains the font of the label. The possible 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

fontColor 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

fontSize contains the size of the font. Default value is "11". A negative value places the label in a mirrored alignment from where it is expected.

fontStyle: string

fontStyle contains the style of the font. Possible values are "bold", "regular", "italic", "underline", "outline", or "bolditalic". Default value is "regular". If fontStyle is not NULL, antialiasing is "false".

halignment: string

halignment contains the horizontal alignment of the label. Possible values are "right", "left", or "center". Default value is "right".

interval: integer

interval contains the distance in pixels from the marker point. Default value is "8". Value must be a positive integer.

outlineColor: string

outlineColor contains the outline color of the label. 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 null.

transparency: double

transparency contains the transparency of the label text. It does not affect the text outline. Values can be 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

valignment contains the vertical alignment of the label. Possible values are "top", "bottom", or "center". Default value is "top".

}

Example (Java)

labelDescription.antialiasing = "false";
labelDescription.font = "times new roman;
labelDescription.fontColor = "255,255,0";
labelDescription.fontSize = 15 ;
labelDescription.fontStyle = "italic";
labelDescription.interval = 10 ;
labelDescription.outlineColor ="0,0,0";
labelDescription.halignment = "right" ;
labelDescription.valignment = "bottom";
labelDescription.transparency = 0.9;

Example (VB.NET)

Dim myLabelDescription As New LabelDescription()
labelDescription.antialiasing = "false"
labelDescription.font = "times new roman
labelDescription.fontColor = "255,255,0"
labelDescription.fontSize = 15
labelDescription.fontStyle = "italic"
labelDescription.interval = 10
labelDescription.outlineColor ="0,0,0"
labelDescription.halignment = "right"
labelDescription.valignment = "bottom"
labelDescription.transparency = 0.9

Example (C#.NET)

LabelDescription myLabelDescription = new LabelDescription();
labelDescription.antialiasing = "false";
labelDescription.font = "times new roman;
labelDescription.fontColor = "255,255,0";
labelDescription.fontSize = 15;
labelDescription.fontStyle = "italic";
labelDescription.interval = 10;
labelDescription.outlineColor ="0,0,0";
labelDescription.halignment = "right";
labelDescription.valignment = "bottom";
labelDescription.transparency = 0.9;

Layer {

layerName: string

layerName contains the layer name for which you set the visibility.

visibility: string

visibility contains the visibility of the layer. Possible values are "on", "off" , or "default". 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" may not appear at all extents.  To determine if the layer can be visible at a specific extent, use the method getLayerInfoForExtent.

}

Example (Java)

IMapImage myMapImage = MapImageHelper.bind();
Layer[] myLayers =  myMapImage.getLayerInfo("GDT.Streets.US");
for (int i=0 ; i < myLayers.length ; i++) {
System.out.println("Name : "+myLayers[i].layerName) ;
System.out.println("Visibility : "+myLayers[i].visibility);
}

Example (VB.NET)

Dim myLayers() As Layer
For i = 0 to (myLayers.Length - 1)
Console.WriteLine("Name: " & myLayers(i).layerName)
Console.WriteLine("Visibility: " & myLayers(i).visibility)
Next

Example (C#.NET)

Layer[] myLayers = myMapImage.getLayerInfo("GDT.Streets.US");
for (int i = 0; i < myLayers.Length; i++)
{
Console.WriteLine(myLayers[i])
}

LineDescription {

color: string

color contains the color of the line. 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 is "(0,0,0)".

geometry: Geometry

geometry contains the geometry of the line.

thickness: integer

transparency: double

}

Example (Java)

LineDescription myLineDescription = new LineDescription();
myLineDescription.color = "0,0,0";
myLineDescription.thickness = 5;
myLineDescription.transparency = 0.5;
myLineDescription.geometry = myGeometry;

For myGeometry, see Geometry

Example (VB.NET)

Dim myLineDescription As New LineDescription() myLineDescription.color = "0,0,0"
myLineDescription.thickness = 5
myLineDescription.transparency = 0.5
myLineDescription.geometry = myGeometry

For myGeometry, see Geometry

Example (C#.NET)

LineDescription myLineDescription = new LineDescription();
myLineDescription.color = "0,0,0";
myLineDescription.thickness = 5;
myLineDescription.transparency = 0.5;
myLineDescription.geometry = myGeometry;

For myGeometry, see Geometry

Location {  

description1: string

description1 contains the long description of the place (e.g., Redlands, California, United States).

description2: string

description2 contains the short description of the place (e.g., Redlands). Not used in Address Finder.

locationExtent: Envelope

locationExtent contains the bounding extent of the place. Not used in Address Finder.

matchType: string

matchType contains the type of match for the address location. See Match codes for more information. Not used in Place Finder or Place Finder Sample.

point: Point

point contains the x,y coordinate and the coordinate system of the place.

score: double

score 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. Not used in Address Finder (score returned as 0.0)

type: string

type contains a letter indicating the type of place. See Place type codes for more information. Not used in Address Finder.

}

Example (Java)

Location myLocation = myLocationInfo.candidates[0];
System.out.println("Description1 : " + myLocation.description1);
System.out.println("Description2 : " + myLocation.description2);
System.out.println("MatchType : " + myLocation.matchType);
System.out.println("Score : " + myLocation.score);
System.out.println("Type : " + myLocation.type);
System.out.println("X : " + myLocation.point.x);
System.out.println("Y : " + myLocation.point.y);

//Envelope is only returned for Place Finder and Place Finder Sample Web Services.

For myLocationInfo, see findPlace or findAddress

Example (VB.NET)

Dim myLocation As New Location
myLocation = myLocationInfo.candidates(0)
Console.WriteLine("Description1 : " & myLocation.description1)
Console.WriteLine("Description2 : " & myLocation.description2)
Console.WriteLine("MatchType : " & myLocation.matchType)
Console.WriteLine("Score : " & myLocation.score)
Console.WriteLine("Type : " & myLocation.type)
Console.WriteLine("X : " & myLocation.point.x)
Console.WriteLine("Y : " & myLocation.point.y)

'Envelope is only returned for Place Finder or Place Finder Sample Web Services

Dim myEnvelope As New Envelope()
myEnvelope = myLocation.locationExtent
Console.WriteLine("MaxX : " & myEnvelope.maxx)
Console.WriteLine("MaxY : " & myEnvelope.maxy)
Console.WriteLine("MinX : " & myEnvelope.minx)
Console.WriteLine("MinY : " & myEnvelope.miny)
 

For myLocationInfo, see findPlace or findAddress

Example (C#.NET)

Location myLocation = myLocationInfo.candidates[0];
Console.WriteLine("Description1 : " + myLocation.description1);
Console.WriteLine("Description2 : " + myLocation.description2);
Console.WriteLine("MatchType : " + myLocation.matchType);
Console.WriteLine("Score : " + myLocation.score);
Console.WriteLine("Type : " + myLocation.type);
Console.WriteLine("X : " + myLocation.point.x);
Console.WriteLine("Y : " + myLocation.point.y);

//Envelope is only returned for Place Finder and Place Finder Sample Web Services.

Envelope myEnvelope = myLocation.locationExtent;
Console.WriteLine("MaxX : " + myEnvelope.maxx);
Console.WriteLine("MaxY : " + myEnvelope.maxy);
Console.WriteLine("MinX : " + myEnvelope.minx);
Console.WriteLine("MinY : " + myEnvelope.miny);

For myLocationInfo, see findPlace or findAddress

LocationInfo {

LocationInfo contains the result of the location query.

candidates: Location[]

candidates contains the list of found places that match the input criteria.

errorCode: string

errorCode contains an error code in the case of NOMATCH. Error codes are returned for United States addresses only. See Error messages for more information. Not used in Place Finder or Place Finder Sample.

hasMore: boolean

hasMore determines whether there are more records available to be requested in a location query result. It is set to "true" if count in PlaceFinderOptions is less than the total number of records.

matchType: string

matchType contains the type of candidate match. The possible values are "CANDIDATES", "ERROR", "EXACT", "NOMATCH".

}

Example (Java)

LocationInfo in Place Finder

IPlaceFinder myPlaceFinder = PlaceFinderHelper.bind();
LocationInfo myLocationInfo = myPlaceFinder.findPlace("Redlands,CA", myPlaceFinderOptions);
System.out.println(Match Type = +myLocationInfo.matchType);
System.out.println(hasMore = +myLocationInfo.hasMore);
System.out.println("Number of Candidates : " +myLocationInfo.candidates.length);

LocationInfo in Place Finder Sample

IPlaceFinderSample myPlaceFinderSample = PlaceFinderSampleHelper.bind();
LocationInfo myLocationInfo = myPlaceFinderSample.findPlace("Redlands,CA", myPlaceFinderOptions);
System.out.println(Match Type = +myLocationInfo.matchType);
System.out.println(hasMore = +myLocationInfo.hasMore);
System.out.println("Number of Candidates : " +myLocationInfo.candidates.length);

LocationInfo in Address Finder

IAddressFinder myAddressFinder = AddressFinderHelper.bind();
LocationInfo myLocationInfo = myAddressFinder.findAddress(myAddress, myAddressFinderOptions,token);
System.out.println("Number of Candidates : " + myLocationInfo.candidates.length);
System.out.println("Match Type : " + myLocationInfo.matchType);
System.out.println(hasMore = +myLocationInfo.hasMore);

LocationInfo in Address Manager

IAddressManager myAddressManager = AddressManagerHelper.bind();
Address[] myAddresses = new Address[1] ;
myAddresses[0] = myAddress;
AddressManagerInfo myAddressManagerInfo = myAddressManager.findAddresses(myAddresses, myAddressManagerOptions, token);
LocationInfo[] myLocationInfo = myAddressManagerInfo.results ;
System.out.println("Number of Candidates : " + myLocationInfo[0].candidates.length);
System.out.println("Match Type : " + myLocationInfo[0].matchType);
System.out.println("hasMore = "+myLocationInfo[0].hasMore);

For myPlaceFinderOptions, see PlaceFinderOptions

For myAddressFinderOptions, see AddressFinderOptions

For myAddressManagerOptions, see AddressManagerOptions

For myAddress, see Address

For token, see getToken

Example (VB.NET)

LocationInfo in Place Finder

Dim myPlaceFinder As New PlaceFinder()
Dim myLocationInfo As New LocationInfo()
myLocationInfo = myPlaceFinder.findPlace("Redlands,CA", myPlaceFinderOptions)
Console.WriteLine("Match Type = " & myLocationInfo.matchType)
Console.WriteLine("hasMore = " & myLocationInfo.hasMore.ToString())
Console.WriteLine("Number of Candidates : " & myLocationInfo.candidates.length.ToString())

LocationInfo in Place Finder Sample

Dim myPlaceFinderSample As New PlaceFinderSample()
Dim myLocationInfo As New LocationInfo()
myLocationInfo = myPlaceFinderSample.findPlace("Redlands,CA", myPlaceFinderOptions)
Console.WriteLine("Match Type = " & myLocationInfo.matchType);
Console.WriteLine("hasMore = " & myLocationInfo.hasMore.ToString());
Console.WriteLine("Number of Candidates : " & myLocationInfo.candidates.length.ToString());

LocationInfo in Address Finder

Dim myAddressFinder As New AddressFinder()
Dim myLocationInfo As New LocationInfo()
myAddressFinder.findAddress(myAddress, myAddressFinderOptions,token)
Console.WriteLine("Number of Candidates : " &  myLocationInfo.candidates.length.ToString())
Console.WriteLine("Match Type : " & myLocationInfo.matchType)
Console.WriteLine("hasMore = " & myLocationInfo.hasMore.ToString())

LocationInfo in Address Manager

Dim myAddressManager As New AddressManager()
Dim myAddresses(0) As Address
Dim myAddressesManagerInfo as AddressManagerInfo
myAddressManagerInfo = myAddressManager.findAddresses(myAddress, myAddressManagerOptions,token)
Dim myLocationInfo As New LocationInfo()
myLocationInfo = myAddressManagerInfo.results
Console.WriteLine("Number of Candidates : " &  myLocationInfo.candidates.length)
Console.WriteLine("Match Type : " & myLocationInfo.matchType)
Console.WriteLine("hasMore = " & myLocationInfo.hasMore)

For myPlaceFinderOptions, see PlaceFinderOptions

For myAddressFinderOptions, see AddressFinderOptions

For myAddressManagerOptions, see AddressManagerOptions

For myAddress, see Address

For token, see getToken

Example (C#.NET)

LocationInfo in Place Finder

PlaceFinder myPlaceFinder = new PlaceFinder();
LocationInfo myLocationInfo = myPlaceFinder.findPlace("Redlands,CA", myPlaceFinderOptions);
Console.WriteLine("Match Type = " + myLocationInfo.matchType);
Console.WriteLine("hasMore = " + myLocationInfo.hasMore.ToString());
Console.WriteLine("Number of Candidates : " + myLocationInfo.candidates.length.ToString());

LocationInfo in Place Finder Sample

PlaceFinderSample myPlaceFinderSample = new PlaceFinderSample();
LocationInfo myLocationInfo = myPlaceFinderSample.findPlace("Redlands,CA", myPlaceFinderOptions);
Console.WriteLine("Match Type = " + myLocationInfo.matchType);
Console.WriteLine("hasMore = " + myLocationInfo.hasMore.ToString());
Console.WriteLine("Number of Candidates : " + myLocationInfo.candidates.length.ToString());

LocationInfo in Address Finder

AddressFinder myAddressFinder = new AddressFinder();
LocationInfo myLocationInfo = myAddressFinder.findAddress(myAddress, myAddressFinderOptions,token);
Console.WriteLine("Number of Candidates : " +  myLocationInfo.candidates.length.ToString());
Console.WriteLine("Match Type : " + myLocationInfo.matchType);
Console.WriteLine("hasMore = " + myLocationInfo.hasMore.ToString());

LocationInfo in Address Manager

AddressManager myAddressManager = new AddressManager();
Address[] myAddresses = new Address[1] ;
myAddresses[0] = myAddress;
AddressManagerInfo myAddressManagerInfo = myAddressManager.findAddresses(myAddresses, myAddressManagerOptions, token);
LocationInfo[] myLocationInfo = myAddressManagerInfo.results;
Console.WriteLine("Number of Candidates : " + myLocationInfo[0].candidates.Length);
Console.WriteLine("Match Type : " + myLocationInfo[0].matchType);
Console.WriteLine("hasMore = "+myLocationInfo[0].hasMore);

For myPlaceFinderOptions, see PlaceFinderOptions

For myAddressFinderOptions, see AddressFinderOptions

For myAddressManagerOptions, see AddressManagerOptions

For myAddress, see Address

For token, see getToken

MapImageInfo {

legendUrl: string

legendUrl contains the output URL of the legend.

mapExtent: Envelope

mapExtent contains the envelope of the output map image.

mapUrl: string

mapUrl contains the output URL of the map image.

}

Example (Java)

IMapImage myMapImage = MapImageHelper.bind();
MapImageInfo myMapImageInfo = myMapImage.getBestMap(myMapImageOptions,token);

System.out.println("Map URL : " + myMapImageInfo.mapUrl);
System.out.println("Legend URL : " + myMapImageInfo.legendUrl);

Envelope myEnvelope = myMapImageInfo.mapExtent;
System.out.println("MaxX : " + myEnvelope.maxx);
System.out.println("MaxY : " + myEnvelope.maxy);
System.out.println("MinX : " + myEnvelope.minx);
System.out.println("MinY : " + myEnvelope.miny);

For token, see getToken

For myMapImageOptions, see MapImageOptions

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myMapImageInfo As New MapImageInfo()
myMapImageInfo = myMapImage.getBestMap(myMapImageOptions, token)
Console.WriteLine("Map URL : " & myMapImageInfo.mapUrl)
Console.WriteLine("Legend URL : " & myMapImageInfo.legendUrl)
Dim myEnvelope As New Envelope()
myEnvelope = myMapImageInfo.mapExtent
Console.WriteLine("MaxX : " & myEnvelope.maxx)
Console.WriteLine("MaxY : " & myEnvelope.maxy)
Console.WriteLine("MinX : " & myEnvelope.minx)
Console.WriteLine("MinY : " & myEnvelope.miny)

For token, see getToken

For myMapImageOptions, see MapImageOptions

Example (C#.NET)

MapImage myMapImage = new MapImage();
MapImageInfo myMapImageInfo = myMapImage.getBestMap(myMapImageOptions,token);
Console.WriteLine("Map URL : " + myMapImageInfo.mapUrl);
Console.WriteLine("Legend URL : " + myMapImageInfo.legendUrl);
Envelope myEnvelope = myMapImageInfo.mapExtent;
Console.WriteLine("MaxX : " + myEnvelope.maxx);
Console.WriteLine("MaxY : " + myEnvelope.maxy);
Console.WriteLine("MinX : " + myEnvelope.minx);
Console.WriteLine("MinY : " + myEnvelope.miny);

For token, see getToken

For myMapImageOptions, see MapImageOptions

MapImageOptions {  

backgroundColor: string

backgroundColor contains the background color of the map image. 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  "255,255,255" (white).

circles: CircleDescription[]

circles contains the circles to include on the map image.

dataSource: string

dataSource contains the name of the data source used by Map Image and Route Finder. It is required. See Data sources and credits for a list of possible values.

displayLayers: Layer[]

displayLayers contains the map layers that are visible. The default visible layers on the map image are displayed if displayLayers is not set. Use getLayerInfoForExtent method to see which layers are visible by default for a certain extent.

drawScaleBar: boolean

drawScaleBar determines whether a scale bar is drawn on the map image. The length of the scale bar is 25% of the map image width. Default value is "false".

lines: LineDescription[]

lines contains the lines to include on the map image.

mapImageFormat: string

mapImageFormat contains the image format of the map. The value can be "jpg", "png", "gif", or "png8". Default value is "png8".

mapImageSize: MapImageSize

mapImageSize contains the height and width, in pixels, of the map image.

markers: MarkerDescription[]

markers contains the markers to include on the map image.

outputCoordSys: CoordinateSystem

outputCoordSys contains the coordinate system of the map image. See Coordinate Systems for possible values.

polygons: PolygonDescription[]

polygons contains the polygons to include on the map.

returnLegend: boolean

returnLegend determines whether or not a legend is included with the map image. Default value is "false".

scaleBarPixelLocation: PixelCoord

scaleBarPixelLocation contains the location of the scale bar on the map image. Default value is (0,13). The length of the scale bar is 25% of the map image width. Note: small x and y values may be obscured by the copyright text.

}

Example (Java)

MarkerDescription myMarkerDescriptionArray[] = new MarkerDescription[1];
myMarkerDescriptionArray[0] = myMarkerDescription;
LineDescription myLineDescriptionArray[] = new LineDescription[1];
myLineDescriptionArray[0] = myLineDescription;
PolygonDescription myPolygonDescriptionArray[] = new PolygonDescription[1];
myPolygonDescriptionArray[0] = myPolygonDescription;
CircleDescription myCircleDescriptionArray[] = new CircleDescription[1];
myCircleDescriptionArray[0] = myCircleDescription;
MapImageOptions myMapImageOptions = new MapImageOptions();
myMapImageOptions.dataSource = "GDT.Streets.US";
myMapImageOptions.mapImageFormat = "jpg";
myMapImageOptions.mapImageSize = myMapImageSize;
myMapImageOptions.backgroundColor = "255,255,0";
myMapImageOptions.drawScaleBar = true;
myMapImageOptions.scaleBarPixelLocation = myPixelCoord;
myMapImageOptions.returnLegend = true;
myMapImageOptions.markers = myMarkerDescriptionArray;
myMapImageOptions.lines = myLineDescriptionArray;
myMapImageOptions.polygons = myPolygonDescriptionArray;
myMapImageOptions.circles = myCircleDescriptionArray;
myMapImageOptions.displayLayers = myLayers;
myMapImageOptions.outputCoordSys: = myCoordinateSystem;

For myMarkerDescription, see MarkerDescription

For myLineDescription, see LineDescription

For myPolygonDescription, see PolygonDescription

For myCircleDescription, see CircleDescription

For myMapImage, see MapImageSize

For myPixelCoord, see PixelCoord

For myLayers, see Layer

For myCoordinateSystem, see CoordinateSystem

Example (VB.NET)

Dim myMarkerDescriptionArray(0) As MarkerDescription
myMarkerDescriptionArray(0) = myMarkerDescription
Dim myLineDescriptionArray(0) As New LineDescription
myLineDescriptionArray(0) = myLineDescription
Dim myPolygonDescriptionArray(0) As New PolygonDescription
myPolygonDescriptionArray(0) = myPolygonDescription
Dim myCircleDescriptionArray(0) As New CircleDescription
myCircleDescriptionArray(0) = myCircleDescription
Dim myMapImageOptions As New MapImageOptions()
myMapImageOptions.dataSource = "GDT.Streets.US"
myMapImageOptions.mapImageFormat = "jpg"
myMapImageOptions.mapImageSize = myMapImageSize
myMapImageOptions.backgroundColor = "255,255,0"
myMapImageOptions.drawScaleBar = true
myMapImageOptions.scaleBarPixelLocation = myPixelCoord
myMapImageOptions.returnLegend = true
myMapImageOptions.markers = myMarkerDescriptionArray
myMapImageOptions.lines = myLineDescriptionArray
myMapImageOptions.polygons = myPolygonDescriptionArray
myMapImageOptions.circles = myCircleDescriptionArray
myMapImageOptions.displayLayers = myLayers

For myMarkerDescription, see MarkerDescription

For myLineDescription, see LineDescription

For myPolygonDescription, see PolygonDescription

For myCircleDescription, see CircleDescription

For myMapImage, see MapImageSize

For myPixelCoord, see PixelCoord

For myLayers, see Layer

For myCoordinateSystem, see CoordinateSystem

Example (C#.NET)

MarkerDescription[] myMarkerDescriptionArray = new MarkerDescription[1];
myMarkerDescriptionArray[0] = myMarkerDescription;
LineDescription[] myLineDescriptionArray = new LineDescription[1];
myLineDescriptionArray[0] = myLineDescription;
PolygonDescription[] myPolygonDescriptionArray = new PolygonDescription[1];
myPolygonDescriptionArray[0] = myPolygonDescription;
CircleDescription[] myCircleDescriptionArray = new CircleDescription[1];
myCircleDescriptionArray[0] = myCircleDescription;
MapImageOptions myMapImageOptions = new MapImageOptions();
myMapImageOptions.dataSource = "GDT.Streets.US";
myMapImageOptions.mapImageFormat = "jpg";
myMapImageOptions.mapImageSize = myMapImageSize;
myMapImageOptions.backgroundColor = "255,255,0";
myMapImageOptions.drawScaleBar = true;
myMapImageOptions.scaleBarPixelLocation = myPixelCoord;
myMapImageOptions.returnLegend = true;
myMapImageOptions.markers = myMarkerDescriptionArray;
myMapImageOptions.lines = myLineDescriptionArray;
myMapImageOptions.polygons = myPolygonDescriptionArray;
myMapImageOptions.circles = myCircleDescriptionArray;
myMapImageOptions.displayLayers = myLayers;
myMapImageOptions.outputCoordSys: = myCoordinateSystem;

For myMarkerDescription, see MarkerDescription

For myLineDescription, see LineDescription

For myPolygonDescription, see PolygonDescription

For myCircleDescription, see CircleDescription

For myMapImage, see MapImageSize

For myPixelCoord, see PixelCoord

For myLayers, see Layer

For myCoordinateSystem, see CoordinateSystem

MapImageSize {

height: integer

height contains the height in pixels of the map image. The minimum value is "5" and the maximum value is "6000".

width: integer

width contains the width in pixels of the map image. The minimum value is "5" and the maximum value is "6000".

}

Example (Java)

MapImageSize myMapImageSize = new MapImageSize();
myMapImageSize.height = 500;
myMapImageSize.width = 500;

Example (VB.NET)

Dim myMapImageSize As New MapImageSize() myMapImageSize.height = 500
myMapImageSize.width = 500

Example (C#.NET)

MapImageSize myMapImageSize = new MapImageSize(); myMapImageSize.height = 500;
myMapImageSize.width = 500;

MarkerDescription {

color: string

color contains the color of the marker. Color style is defined as an R,G,B string with each value between 0 and 255, (for example, "255,0,0" is red). Used in ESRI.Simple.Icons (i.e., not used in ESRI.Raster.Icons or User.Defined.Icons). Default value is "0,0,0" (black).

iconDataSource: string

iconDataSource contains the name of the icon data source to used by Map Image and Route Finder. Valid values are "ESRI.Simple.Icons", "ESRI.Raster.Icons", or "User.Defined.Icons". ESRI.Simple.Icons include circle, cross, square, star, and triangle. See ESRI.Raster.Icons for a table of available raster and simple icons. Use getMarkerNames or getMyMarkerNames methods for the most complete list of icons for each iconDataSource. Note: You can use "null" value if you wish to add a label without a marker.

label: string

label contains a label for the marker, for example "MyStore".

labelDescription: LabelDescription

labelDescription contains the properties of the marker label such as font and font color. You can add a label without an icon by defining the iconDataSource value as "null".

location: Point

location contains the location of the marker in coordinates.

name: string

name contains the name of the marker. The possible values for ESRI.Simple.Icons are, "circle", "cross", "square", "star", and "triangle". See ESRI.Raster.Icons for a table of available raster icon names.

}

Example (Java)

Point myPoint = new Point();
myPoint.x = -117.199577;
myPoint.y = 34.048364;

MarkerDescription myMarkerDescription = new MarkerDescription();
myMarkerDescription.name = "triangle";
myMarkerDescription.iconDataSource = "ESRI.Simple.Icons";
myMarkerDescription.color = "255,0,0";
myMarkerDescription.label = "MarkerDescription Example";
myMarkerDescription.location = myPoint;

Example (VB.NET)

Dim mypoint As New Point()
mypoint.x = -117.199577
mypoint.y = 34.048364

Dim myMarkerDescription As New MarkerDescription()
myMarkerDescription.name = "triangle"
myMarkerDescription.iconDataSource = "ESRI.Simple.Icons"
myMarkerDescription.color = "255,0,0"
myMarkerDescription.label = "MarkerDescription Example"
myMarkerDescription.location = mypoint

Example (C#.NET)

Point myPoint = new Point();
myPoint.x = -117.199577;
myPoint.y = 34.048364;

MarkerDescription myMarkerDescription = new MarkerDescription();
myMarkerDescription.name = "triangle";
myMarkerDescription.iconDataSource = "ESRI.Simple.Icons";
myMarkerDescription.color = "255,0,0";
myMarkerDescription.label = "MarkerDescription Example";
myMarkerDescription.location = myPoint;

PixelCoord {

x: integer

y: integer

}

Example (Java)

PixelCoord myPixelCoord = new PixelCoord();
myPixelCoord.x = 20;
myPixelCoord.y = 10;

Example (VB.NET)

Dim myPixelCoord As New PixelCoord() myPixelCoord.x = 20
myPixelCoord.y = 10

Example (C#.NET)

PixelCoord myPixelCoord = new PixelCoord(); myPixelCoord.x = 20;
myPixelCoord.y = 10;

PlaceFinderOptions {

count: integer

count contains the number of records that are returned in the results. Counting begins at 0, so to get the first record through the sixth record, set count to "6" and startIndex to "0". Default returns the first 20 records.

dataSource: string

dataSource contains the name of the data source used by Place Finder and Place Finder Sample. It is required. See Data sources and credits for a list of possible values.

filterCountry: string

filterCountry contains the country, dependency, or area of special sovereignty to search. See Country codes for a list of possible values. The default value is "null", which means no country or territory restrictions.

filterEnvelope: Envelope

filterEnvelope contains the geographic area to search. The default value is null, which means no area restrictions.

filterType: string

filterType contains the types of places to search. See ID codes for a list of valid place types. To choose multiple filters, separate with commas and no spaces (e.g., "A,B,C"). Default value is null which returns all types.

searchType: string

searchType contains the type of search to perform. Possible values are "startsWith" or "exactMatch". The default value is "startsWith".

startIndex: integer

startIndex contains the first record number to be returned. Counting begins at 0, so to get the first record through the sixth record, set count to "6" and startIndex to "0".

}

Example (Java)

PlaceFinderOptions myPlaceFinderOptions = new PlaceFinderOptions();
myPlaceFinderOptions.count=1;
myPlaceFinderOptions.dataSource = "ESRI.Gazetteer.World";
myPlaceFinderOptions.filterCountry="US";
myPlaceFinderOptions.filterEnvelope= myEnvelope;
myPlaceFinderOptions.filterType="G,J";
myPlaceFinderOptions.searchType="exactMatch";
myPlaceFinderOptions.startIndex=0;

For myEnvelope, see Envelope

Example (VB.NET)

Dim myPlaceFinderOptions As New PlaceFinderOptions()
myPlaceFinderOptions.count=1
myPlaceFinderOptions.dataSource = "ESRI.Gazetteer.World"
myPlaceFinderOptions.filterCountry="US"
myPlaceFinderOptions.filterEnvelope= myEnvelope
myPlaceFinderOptions.filterType="G,J"
myPlaceFinderOptions.searchType="exactMatch"
myPlaceFinderOptions.startIndex=0

For myEnvelope, see Envelope

Example (C#.NET)

PlaceFinderOptions myPlaceFinderOptions = new PlaceFinderOptions();
myPlaceFinderOptions.count=1;
myPlaceFinderOptions.dataSource = "ESRI.Gazetteer.World";
myPlaceFinderOptions.filterCountry="US";
myPlaceFinderOptions.filterEnvelope= myEnvelope;
myPlaceFinderOptions.filterType="G,J";
myPlaceFinderOptions.searchType="exactMatch";
myPlaceFinderOptions.startIndex=0;

For myEnvelope, see Envelope

Poi {

city: string

city contains the city name of the address.

country: string

country contains the country name of the address.

desc: string[]

desc contains a description of the address. You can have up to 20 desc fields for each POI record. Each desc field can have a maximum of 256 characters.

id: string

id contains the unique ID of the address.

matchType: string

matchType contains the type of match for the address. See Match codes for more information.

placeName: string

placeName contains the name of the address. Unique names are recommended but not required. You can have a maximum of 128 characters.

point: Point

point contains the x,y coordinate and the coordinate system of the address.

state: string

state contains the state or province name.

street1: string

street1 contains the first line of the street address.

street2: string

street2 contains the second line of the street address.

type: string

type contains the type of address. For example, your address file might contain a list of schools, in which case, type would be "School". You can have a maximum of 128 characters.

zip: string

zip contains the ZIP Code or postal code of the address.

}

Example (Java)

Poi myPoi = new Poi();
myPoi.street1 = "380 New York St";
myPoi.city = "Redlands";
myPoi.state = "CA";
myPoi.zip = "92373";
myPoi.country = "US";
myPoi.type = "headquarters";
String[] myDesc = new String[1];
myDesc[0] = "ESRI Headquarters";
myPoi.desc = myDesc;

Example (VB.NET)

Dim myPoi As New Poi()
Dim myDesc() As String
myPoi.street1 = "380 New York St"
myPoi.city = "Redlands"
myPoi.state = "CA"
myPoi.zip = "92373"
myPoi.country = "US"
myPoi.type = "headquarters"
myDesc(0) = "ESRI Headquarters"
myPoi.desc = myDesc

Example (C#.NET)

Poi myPoi = new Poi();
String[0] myDesc = "ESRI Headquarters";
myPoi.street1 = "380 New York St";
myPoi.city = "Redlands";
myPoi.state = "CA";
myPoi.zip = "92373";
myPoi.country = "US";
myPoi.type = "headquarters";
myPoi.desc = myDesc;

PoiManagerOptions {

PoiManagerOptions contains parameters for using POI Manager Web Service.

dataSource: string

dataSource contains the name of the data source used by POI Manager. It is required. See Data sources and credits for a list of possible values.

}

Example (Java)

PoiManagerOptions myPoiManagerOptions = new PoiManagerOptions();
myPoiManagerOptions.dataSource = "GDT.Streets.US";

Example (VB.NET)

Dim myPoiManagerOptions As New PoiManagerOptions()
myPoiManagerOptions.dataSource = "GDT.Streets.US"

Example (C#.NET)

PoiManagerOptions myPoiManagerOptions = new PoiManagerOptions();
myPoiManagerOptions.dataSource = "GDT.Streets.US";

Point {  

coordinateSystem: CoordinateSystem

coordinateSystem contains the coordinate system of the point. Default value is projection "4326".

x: double

x contains the x coordinate of the point.

y: double

}

Example (Java)

Point myPoint = new Point()
myPoint.x = -117.634589;
myPoint.y = 33.890873;
myPoint.coordinateSystem = myCoordinateSystem;

Example (VB.NET)

Dim myPoint As New Point()
myPoint.x = -117.634589
myPoint.y = 33.890873

Example (C#.NET)

myPoint = new Point();
myPoint.x = -117.634589;
myPoint.y = 33.890873;

PoiResultSet {

pois: Poi[]

pois contains an array of POI records.

totalCount: long

totalCount contains the total number of POI records that meet the given QueryParams constraints. For example, if 50 records match and the count was specified to be 20, the totalCount is 50 even though only 20 POI records are actually returned to the client.  The remaining 30 records can be retrieved in future requests.

}

Example (Java)

IPoiManager myPoiManager = PoiManagerHelper.bind();
PoiResultSet myPoiResultSet = myPoiManager.findLocations(myQueryParams, token);
System.out.println("Total matches: " + myPoiResultSet.totalCount);
Poi[] myPois = myPoiResultSet.pois;
for (int i = 0; i < myPois.length; i++) {
System.out.println("PlaceName: " + myPois[i].placeName);
System.out.println("City: " + myPois[i].city);
System.out.println(" ");
}

Example (VB.NET)

Dim myPoiManager As New PoiManager()
Dim myPoiResultSet As New PoiResultSet()
Dim myQueryParams As New QueryParams()
Dim myPois() As Poi
Dim i As Integer
myPoiResultSet = myPoiManager.findLocations(myQueryParams, token)
myPois = myPoiResultSet.pois
Console.WriteLine("Total matches: " & myPoiResultSet.totalCount.ToString())
For i = 0 to (myPois.Length - 1)
Console.WriteLine("PlaceName: " & myPois(i).placeName)
Console.WriteLine("City: " & myPois(i).city)
Console.WriteLine(" ")
Next

Example (C#.NET)

PoiManager myPoiManager = new PoiManager();
PoiResultSet myPoiResultSet = new PoiResultSet();
QueryParams myQueryParams = new QueryParams();
int i;
myPoiResultSet = myPoiManager.findLocations(myQueryParams, token);
Poi[] myPois = myPoiResultSet.pois;
Console.WriteLine("Total matches: " + myPoiResultSet.totalCount.ToString());
for (i = 0; i < myPois.Length; i++)
{
Console.WriteLine("PlaceName: " & myPois[i].placeName);
Console.WriteLine("City: " & myPois[i].city);
Console.WriteLine(" ");
}

PolygonDescription {

boundaryColor: string

boundaryColor contains the color of the polygon outline. Color style is defined as an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). The default is "0,0,0" (black).

fillColor: string

fillColor contains the color of the polygon fill. Color style is defined as an R,G,B string with each value between 0-255, for example ("255,0,0" is red). The default is "0,255,0" (green).

fillType: string

fillType contains the type of pattern of the polygon fill. Values can be "bdiagonal", "cross", "diagcross", "fdiagonal", "horizontal", "solid", and "vertical". The default is "solid".

geometry: Geometry

geometry contains the geometry of the polygon.

transparency: double

transparency contains the transparency of the polygon. Values can be between 0.0 (fully transparent) and 1.0 (fully opaque). The default is "0.0". If you set the value above "1.0", you receive an error message.

}

Example (Java)

Point myPoint3 = new Point();
Point myPoint4 = new Point();
Point myPoint5 = new Point();
myPoint3.x = -117.199577;
myPoint3.y = 34.048364;
myPoint4.x = -117.179577;
myPoint4.y = 34.018364;
myPoint5.x = -117.179577;
myPoint5.y = 34.022364;

Point myPolyPoints[]= new Point[3];
myPolyPoints[0] = point3;
myPolyPoints[1] = point4;
myPolyPoints[2] = point5;

int[] myPolyParts = new int[1];
myPolyParts[0] = 0;

Geometry myPolyGeometry = new Geometry();
myPolyGeometry.points = myPolyPoints ;

myPolyGeometry.parts = myPolyParts;
myPolyGeometry.type = 3;

PolygonDescription myPolygonDescription = new PolygonDescription() ;
myPolygonDescription.boundaryColor = "255,255,255";
myPolygonDescription.fillColor = "0,0,0";
myPolygonDescription.fillType = "solid";
myPolygonDescription.transparency = 0.3;
myPolygonDescription.geometry = myPolyGeometry;

Example (VB.NET)

Dim myPoint3 As New Point()
Dim myPoint4 As New Point()
Dim myPoint5 As New Point()
myPoint3.x = -117.199577
myPoint3.y = 34.048364
myPoint4.x = -117.179577
myPoint4.y = 34.018364
myPoint5.x = -117.179577
myPoint5.y = 34.022364
Dim myPolyPoints(2) As Point
myPolyPoints(0) = myPoint3
myPolyPoints(1) = myPoint4
myPolyPoints(2) = myPoint5
Dim myPolyParts(0) As Integer
myPolyParts(0) = 0;
Dim myPolyGeometry As New Geometry()
myPolyGeometry.parts = myPolyParts
myPolyGeometry.type = 3
myPolyGeometry.points = myPolyPoints
Dim myPolygonDescription As New PolygonDescription()
myPolygonDescription.boundaryColor = "255,255,255"
myPolygonDescription.fillColor = "0,0,0"
myPolygonDescription.fillType = "solid"
myPolygonDescription.transparency = 0.3
myPolygonDescription.geometry = myPolyGeometry

Example (C#.NET)

Point myPoint3 = new Point();
Point myPoint4 = new Point();
Point myPoint5 = new Point();
myPoint3.x = -117.199577;
myPoint3.y = 34.048364;
myPoint4.x = -117.179577;
myPoint4.y = 34.018364;
myPoint5.x = -117.179577;
myPoint5.y = 34.022364;
Point[] myPolyPoints = new Point[3];
myPolyPoints[0] = myPoint3;
myPolyPoints[1] = myPoint4;
myPolyPoints[2] = myPoint5;
int[] myPolyParts = new int[1];
myPolyParts[0] = 0;
Geometry myPolyGeometry = new Geometry();
myPolyGeometry.parts = myPolyParts;
myPolyGeometry.type = 3;
myPolyGeometry.points = myPolyPoints ;
PolygonDescription myPolygonDescription = new PolygonDescription() ;
myPolygonDescription.boundaryColor = "255,255,255";
myPolygonDescription.fillColor = "0,0,0";
myPolygonDescription.fillType = "solid";
myPolygonDescription.transparency = 0.3;
myPolygonDescription.geometry = myPolyGeometry;

ProximityOptions {

dataSource: string

dataSource contains the name of the data source used by Proximity. It is required. See Data sources and credits for a list of possible values.

resultRange: ResultSetRange

resultRange contains the desired start and end index of data to be returned. Record indexes are 0 based. For example, if count = "10", and startIndex="0", records 0-9 are returned. If startIndex < 0 , then default for startIndex in resultRange is set to 0. The default value for count is "20".

returnFieldsList: string[]

returnFieldsList contains the field names that are returned in output. List the field names in the order you would like them displayed. Use getAvailableFieldNames method to see possible fields for data source. By default, all the fields associated with a given data source are returned. Longitude, Latitude, and Distance are always returned.

units: string

units contains the units used to measure distance from a point. Possible values are "miles" or "km". The default value is "miles".

whereClause: string

}

Example (Java)

string myFieldsList[] = new string[2];
myFieldsList[0] = "NAME";
myFieldsList[1] = "TYPE";

ProximityOptions myProximityOptions = new ProximityOptions();
myProximityOptions.dataSource = "User.Defined.POI";
myProximityOptions.resultRange = myResultSetRange;
myProximityOptions.returnFieldsList = myFieldsList;
myProximityOptions.whereClause = "CITY='Irvine'";

For myResultSetRange, see ResultSetRange

Example (VB.NET)

Dim myFieldlist(2) As String
myFieldlist(0) = "NAME"
myFieldlist(1) = "TYPE"

Dim myProximityOptions As New ProximityOptions()
myProximityOptions.dataSource = "User.Defined.POI" myProximityOptions.resultRange = myResultSetRange myProximityOptions.returnFieldsList = myFieldlist myProximityOptions.whereClause = "CITY='Irvine'"

For myResultSetRange, see ResultSetRange

Example (C#.NET)

string [] myFieldsList = new string[2];
 myFieldsList[0] = "NAME";
 myFieldsList[1] = "TYPE";

ProximityOptions myProximityOptions = new ProximityOptions();
myProximityOptions.dataSource = "User.Defined.POI";
myProximityOptions.resultRange = myResultSetRange;
myProximityOptions.returnFieldsList = myFieldsList;
myProximityOptions.whereClause = "CITY='Irvine'";

For myResultSetRange, see ResultSetRange

QueryOptions {

dataSource: string

dataSource contains the name of the data source used by Query. It is required. See Data sources and credits for a list of possible values.

geographyLevel: string

returnFieldsList: string[]

}

Example (Java)

string myFieldsList[] = new string[1];
myFieldsList[0] = "ZONE";

QueryOptions myQueryOptions = new QueryOptions();
myQueryOptions.dataSource = "FEMA.Flood.US";
myQueryOptions.geographyLevel = "State";
myQueryOptions.returnFieldsList = myFieldsList;

Example (VB.NET)

Dim myFieldsList(0) As String myFieldsList(0) = "ZONE"

Dim myQueryOptions As New QueryOptions()
myQueryOptions.dataSource = "FEMA.Flood.US"
myQueryOptions.geographyLevel = "State"
myQueryOptions.returnFieldsList = myFieldsList

Example (C#.NET)

string [] myFieldsList = new string[1]; myFieldsList[0] = "ZONE";

QueryOptions myQueryOptions = new QueryOptions();
myQueryOptions.dataSource = "FEMA.Flood.US";
myQueryOptions.geographyLevel = "State";
myQueryOptions.returnFieldsList = myFieldsList;

QueryParams {

city: string

count contains the number of records that are returned in the results.

keyword: string[]

keyword contains the list of strings (e.g., Descriptions or Addresses) in the POI fields by which to constrain the LIKE search. Multiple keywords use the OR operator.

placeName: string

placeName contains the title of the POI records by which to constrain the LIKE search.

startIndex: integer

startIndex contains the number of records to skip in the query. The first record is always 0, so, for example, to get records 11-15, set startIndex to "10".

state: string

state contains the state name by which to constrain the EXACT search.

status: string

status contains the type of geocode matches by which to constrain the search. Possible values are "successful" or "unsuccessful".

type: string

type contains the type of record by which to constrain the EXACT search. For example, your POI records might contain a list of schools, in which case, type would be "School".

zip: string

zip contains the ZIP Code by which to constrain the EXACT search.

}

Example (Java)

QueryParams myQueryParams = new QueryParams();
String[] myKeywords = new String[1];
myKeywords[0] = "My Keyword A";
myQueryParams.city = "Redlands";
myQueryParams.count = 10;
myQueryParams.keyword = myKeywords;
myQueryParams.placeName = "My PlaceName A";
myQueryParams.startIndex = 0;
myQueryParams.state = "CA";
myQueryParams.status = "successful";
myQueryParams.type = "My Type A";
myQueryParams.zip = "92373";

Example (VB.NET)

Dim myQueryParams As New QueryParams()
Dim myKeywords(0) As String
myKeywords(0) = "My Keyword A"
Dim myType As String
myType = "My Type A"
myQueryParams.city = "Redlands"
myQueryParams.count = 10
myQueryParams.keyword = myKeywords
myQueryParams.placeName = "My PlaceName A"
myQueryParams.startIndex = 0
myQueryParams.state = "CA"
myQueryParams.status = "successful"
myQueryParams.type = myTypes
myQueryParams.zip = "92373"

Example (C#.NET)

QueryParams[] myQueryParams = new QueryParams();
String[] myKeywords = new String[1];
myKeywords[0] = "My Keyword A";
String myType = "My Type A";
myQueryParams.city = "Redlands";
myQueryParams.count = 10;
myQueryParams.keyword = myKeywords;
myQueryParams.placeName = "My PlaceName A";
myQueryParams.startIndex = 0;
myQueryParams.state = "CA";
myQueryParams.status = "successful";
myQueryParams.type = myTypes;
myQueryParams.zip = "92373";

ReportInfo {

dataSource contains the name of the data source used by Report.

reportFormat contains the format of the report. Possible values are "excel", "pdf", or "xml". Default value is "pdf".

reportUrl contains the output URL of the report.

}

IReport myReport = ReportHelper.bind();
ReportInfo myReportInfo = myReport.getMapReport(mySites, myReportOptions, token);
System.out.println("Data Source : " + myReportInfo.dataSource);
System.out.println("Report format : " + myReportInfo.reportFormat);
System.out.println("Report URL : " + myReportInfo.reportUrl);

For token, see getToken

For mySites, see Site

For myReportOptions, see ReportOptions

Dim myReport As New Report()
Dim myReportInfo As New ReportInfo()
myReportInfo = myReport.getMapReport(mySites, myReportOptions, token)
Console.WriteLine("Data Source : " & myReportInfo.dataSource)
Console.WriteLine("Report format : " & myReportInfo.reportFormat)
Console.WriteLine("Report URL : " & myReportInfo.reportUrl)

For token, see getToken

For mySites, see Site

For myReportOptions, see ReportOptions

Report myReport = new Report();
ReportInfo myReportInfo = myReport.getMapReport(mySites, myReportOptions, token);
Console.WriteLine("Data Source : " + myReportInfo.dataSource);
Console.WriteLine("Report format : " + myReportInfo.reportFormat);
Console.WriteLine("Report URL : " + myReportInfo.reportUrl);

For token, see getToken

For mySites, see Site

For myReportOptions, see ReportOptions

ReportOptions {

dataSource contains the name of the data source used by Report. It is required. See Data sources and credits for a list of possible values. Note: You are charged for each data source you use in an array (with method getSiteReports).

reportFormat contains the format of the report. Possible values are "excel", "pdf", or "xml". Default value is "pdf".

reportHeader contains the key/value pairs for the header of a report. Default value is "null". Use method getReportHeaderKeys to see a list of key names and value descriptions for reportHeader.

}

ReportOptions myReportOptions = new ReportOptions();
myReportOptions.dataSource = "ESRIBIS.PreviewReport.US";
myReportOptions.reportFormat = "pdf";
myReportOptions.reportHeader = myKeyValues;

For myKeyValues, see KeyValue

Dim myReportOptions As New ReportOptions()
myReportOptions.dataSource = "ESRIBIS.PreviewReport.US"
myReportOptions.reportFormat = "excel"
myReportOptions.reportHeader = myKeyValues

For myKeyValues, see KeyValue

ReportOptions myReportOptions = new ReportOptions();
myReportOptions.dataSource = "ESRIBIS.PreviewReport.US";
myReportOptions.reportFormat = "pdf";
myReportOptions.reportHeader = myKeyValues;

For myKeyValues, see KeyValue

ResultSet {

fields: FieldDesc[]

fields contains an array of fields.

rows: RowData[]

row contains an array of row data.

totalCount contains the total number of rows that meet the given whereClause and radius constraints.  For example, if 50 records match the findNearest or findWithin method and the count was specified to be 20, the totalCount is 50 even though only 20 records are actually returned to the client.  The remaining 30 rows can be retrieved in future requests.  In the case of pointQuery, the total count is always "1".

}

ResultSet in Query

IQuery myQuery = QueryHelper.bind();
ResultSet myResultSet = myQuery.pointQuery(myPoint,myQueryOptions,token);
int totalCount = myResultSet.totalCount;
FieldDesc[] myFieldDesc = myResultSet.fields;
RowData[] myRowData = myResultSet.rows;
System.out.println("Total number of Rows : " + totalCount);

ResultSet in Proximity

IProximity myProximity = ProximityHelper.bind();
ResultSet myResultSet = myProximity.findNearest(myPoint,myProximityOptions,token);
int totalCount = myResultSet.totalCount;
FieldDesc[] myFieldDesc = myResultSet.fields;
RowData[] myRowData = myResultSet.rows;
System.out.println("Total number of Rows : " + totalCount);

ResultSet in Report

IReport myReport = ReportHelper.bind();
ResultSet myResultSet = myReport.getGeographyIds(myGeographyIdOptions);
int totalCount = myResultSet.totalCount;
FieldDesc[] myFieldDesc = myResultSet.fields;
System.out.println("Total number of Rows : " + totalCount);

For myPoint, see Point.

For myQueryOptions, see QueryOptions.

For myProximityOptions, see ProximityOptions.

For myGeographyIdOptions, see GeographyOptions.

For token, see getToken.

ResultSet in Query

Dim myQuery As New Query()
Dim myResultSet As ResultSet
myResultSet = myQuery.pointQuery(myPoint,myQueryOptions,token)
Dim totalCount As Integer
totalCount = myResultSet.totalCount
Dim myFieldDesc() As FieldDesc
myFieldDesc = myResultSet.fields
Dim myRowData() As RowData
myRowData = myResultSet.rows
Console.WriteLine("Total number of Rows : " & totalCount)

ResultSet in Proximity

Dim myProximity As New Proximity()
Dim myResultSet As ResultSet()
myResultSet = myProximity.findNearest(myPoint,myProximityOptions,token)
Dim totalCount As Integer
totalCount = myResultSet.totalCount
Dim myFieldDesc() As FieldDesc
myFieldDesc = myResultSet.fields
Dim myRowData() As RowData
myRowData = myResultSet.rows
Console.WriteLine("Total number of Rows : " & totalCount)

ResultSet in Report

Dim myReport As New Report()
Dim myResultSet As ResultSet
myResultSet = myReport .getGeographyIds(myGeographyIdOptions)
Dim totalCount As Integer
totalCount = myResultSet.totalCount
Dim myFieldDesc() As FieldDesc
myFieldDesc = myResultSet.fields
Dim myRowData() As RowData
myRowData = myResultSet.rows
Console.WriteLine("Total number of Rows : " & totalCount)

For myPoint, see Point

For myQueryOptions, see QueryOptions

For myProximityOptions, see ProximityOptions

For token, see getToken

ResultSet in Query

Query myQuery = new Query();
ResultSet myResultSet = myQuery.pointQuery(myPoint,myQueryOptions,token);
int totalCount = myResultSet.totalCount;
FieldDesc[] myFieldDesc = myResultSet.fields;
RowData[] myRowData = myResultSet.rows;
Console.WriteLine("Total number of Rows : " + totalCount);

ResultSet in Proximity

Proximity myProximity = new Proximity();
ResultSet myResultSet = myProximity.findNearest(myPoint,myProximityOptions,token);
int totalCount = myResultSet.totalCount;
FieldDesc[] myFieldDesc = myResultSet.fields;
RowData[] myRowData = myResultSet.rows;
Console.WriteLine("Total number of Rows : " + totalCount);

ResultSet in Report

Report myReport = new Report();
ResultSet myResultSet = myReport.getGeographyIds(myGeographyIdOptions);
int totalCount = myResultSet.totalCount;
FieldDesc[] myFieldDesc = myResultSet.fields;
RowData[] myRowData = myResultSet.rows;
Console.WriteLine("Total number of Rows : " + totalCount);

For myPoint, see Point.

For myQueryOptions, see QueryOptions.

For myProximityOptions, see ProximityOptions.

For myGeographyIdOptions, see GeographyOptions.

For token, see getToken.

ResultSetRange {

count: integer

count contains the number of records that are returned in the results. The default value is "20".

startIndex: integer

startIndex contains the number of records to skip in the query. The first record is always 0, so, for example, to get records 11-15, set startIndex to "10".

}

Example (Java)

ResultSetRange myResultSetRange = new ResultSetRange();
myResultSetRange.startIndex = 0;
myResultSetRange.count = 2;

Example (VB.NET)

Dim myResultSetRange As New ResultSetRange() myResultSetRange.startIndex = 0 myResultSetRange.count = 2

Example (C#.NET)

ResultSetRange myResultSetRange = new ResultSetRange(); myResultSetRange.startIndex = 0;
myResultSetRange.count = 2;

RouteDisplayOptions {

color: string

thickness: integer

thickness contains the thickness, in pixels, of the route line. The values can be greater than or equal to "1". Default value is "7".

transparency: double

transparency contains the transparency of the route line. Values can be between 0.1 (fully transparent) and 1.0 (fully opaque). The default 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.

}

Example (Java)

RouteDisplayOptions myRouteDisplayOptions = new RouteDisplayOptions();
myRouteDisplayOptions.color = "0,255,0";
myRouteDisplayOptions.thickness = 3;
myRouteDisplayOptions.transparency = 0.25;

Example (VB.NET)

Dim myRouteDisplayOptions As New RouteDisplayOptions()
myRouteDisplayOptions.color = "0,255,0"
myRouteDisplayOptions.thickness = 3
myRouteDisplayOptions.transparency = 0.25

Example (C#.NET)

RouteDisplayOptions myRouteDisplayOptions = new RouteDisplayOptions();
myRouteDisplayOptions.color = "0,255,0";
myRouteDisplayOptions.thickness = 3;
myRouteDisplayOptions.transparency = 0.25;

RouteFinderOptions {

dataSource: string

dataSource contains the name of the data source used by Route Finder. It is required. See Data sources and credits for a list of possible values.

language: string

language contains the language used in the route description. Possible values are: "danish", "dutch", "english", "french", "german", "italian", "norwegian", "portugese", "spanish", or "swedish". The default value is "english".

mapImageOptions: MapImageOptions

mapImageOptions contains the properties of the map image.

returnDirections: boolean

returnDirections determines whether or not a description of the route is returned. The default value is "false". If returnDirections, returnGeometry, and returnMap are "false", only RouteInfo.totalDescription is returned.

returnGeometry: boolean

returnGeometry determines whether or not the geometry of the route is returned. The default value is "false". If returnDirections, returnGeometry, and returnMap are "false", only RouteInfo.totalDescription is returned.

returnMap: boolean

returnMap determines whether or not an image of the route is returned. The default value is "true". Note: You are charged two credits for the findRoute method call when returnMap is "true" —one for the route and one for the map. If returnDirections, returnGeometry, and returnMap are "false", only RouteInfo.totalDescription is returned.

routeDisplayOptions: RouteDisplayOptions

routeDisplayOptions contains parameters for how the route is displayed on a map. For routeDisplayOptions to take effect, returnMap must be set to "true".

routeOptions: RouteOptions

routeOptions contains the properties of the route.

units: string

units contains the units of the route. The possible values are "km" or "miles". The default value is "miles".

}

Example (Java)

RouteFinderOptions myRouteFinderOptions = new RouteFinderOptions();
myRouteFinderOptions.dataSource = "GDT.Streets.US";
myRouteFinderOptions.returnDirections = true;
myRouteFinderOptions.returnGeometry = true;
myRouteFinderOptions.returnMap = true;
myRouteFinderOptions.mapImageOptions =myMapImageOptions;
myRouteFinderOptions.routeOptions = myRouteOptions;
myRouteFinderOptions.routeDisplayOptions = myRouteDisplayOptions;

For myRouteOptions, see RouteOptions

For myRouteDisplayOptions, see RouteDisplayOptions

For myMapImageOptions, see MapImageOptions

Example (VB.NET)

Dim myRouteFinderOptions As New RouteFinderOptions()
myRouteFinderOptions.dataSource = "GDT.Streets.US"
myRouteFinderOptions.returnDirections = True
myRouteFinderOptions.returnGeometry = True
myRouteFinderOptions.returnMap = True
myRouteFinderOptions.mapImageOptions = myMapImageOptions
myRouteFinderOptions.routeOptions = myRouteOptions
myRouteFinderOptions.routeDisplayOptions = myRouteDisplayOptions

For myRouteOptions, see RouteOptions

For myRouteDisplayOptions, see RouteDisplayOptions

For myMapImageOptions, see MapImageOptions

Example (C#.NET)

RouteFinderOptions myRouteFinderOptions = new RouteFinderOptions();
myRouteFinderOptions.dataSource = "GDT.Streets.US";
myRouteFinderOptions.returnDirections = true;
myRouteFinderOptions.returnGeometry = true;
myRouteFinderOptions.returnMap = true;
myRouteFinderOptions.mapImageOptions =myMapImageOptions;
myRouteFinderOptions.routeOptions = myRouteOptions;
myRouteFinderOptions.routeDisplayOptions = myRouteDisplayOptions;

For myRouteOptions, see RouteOptions

For myRouteDisplayOptions, see RouteDisplayOptions

For myMapImageOptions, see MapImageOptions

RouteInfo {

}

IRouteFinder myRouteFinder = RouteFinderHelper.bind();
RouteInfo myRouteInfo = myRouteFinder.findRoute(myRouteStop,myRouteFinderOptions,token);

MapImageInfo myMapImageInfo = new MapImageInfo();
myMapImageInfo = myRouteInfo.mapImageInfo;
System.out.println("Map URL in MapImageInfo : " + myMapImageInfo.mapUrl);

Geometry myGeometry = new Geometry();
myGeometry = myRouteInfo.routePath;
System.out.println("MaxX in Geometry : " + myGeometry.envelope.maxx);

SegDescription[] mySegDescriptionArray = myRouteInfo.segDescriptions;
System.out.println("Description1 in first SegDescription : " + mySegDescriptionArray[0].description1);

SegDescription mySegDescription = new SegDescription();
mySegDescription = myRouteInfo.totalDescription;
System.out.println("Description1 in TotalDescription : " + mySegDescription.description1)

For myRouteStop, see RouteStop

For myRouteFinderOptions, see RouteFinderOptions

For token, see getToken

Dim myRouteFinder As New RouteFinder()
Dim myRouteInfo As New RouteInfo()

myRouteInfo = myRouteFinder.findRoute(myRouteStop,myRouteFinderOptions,token)
Dim myMapImageInfo As New MapImageInfo()
myMapImageInfo = myRouteInfo.mapImageInfo

Console.WriteLine("Map URL in MapImageInfo : " & myMapImageInfo.mapUrl)
Dim myGeometry As New Geometry()
myGeometry = myRouteInfo.routePath
Console.WriteLine("MaxX in Geometry : " & myGeometry.envelope.maxx)

Dim mySegDescriptionArray() As SegDescription
mySegDescriptionArray = myRouteInfo.segDescriptions
Console.WriteLine("Description1 in first SegDescription : " & mySegDescriptionArray(0).description1)

Dim mySegDescription() As SegDescription
mySegDescription = myRouteInfo.totalDescription
Console.WriteLine("Description1 in TotalDescription : " & mySegDescription.description1)

For myRouteStop, see RouteStop

For myRouteFinderOptions, see RouteFinderOptions

For token, see getToken

RouteFinder myRouteFinder = new RouteFinder;
RouteInfo myRouteInfo =
myRouteFinder.findRoute(myRouteStop,myRouteFinderOptions,token);

MapImageInfo myMapImageInfo = new MapImageInfo();
myMapImageInfo = myRouteInfo.mapImageInfo;
Console.WriteLine("Map URL in MapImageInfo : " + myMapImageInfo.mapUrl);

Geometry myGeometry = new Geometry();
myGeometry = myRouteInfo.routePath;
Console.WriteLine("MaxX in Geometry : " + myGeometry.envelope.maxx);

SegDescription[] mySegDescriptionArray = myRouteInfo.segDescriptions;
Console.WriteLine("Description1 in first SegDescription : " +

mySegDescriptionArray[0].description1);
SegDescription mySegDescription = new SegDescription();
mySegDescription = myRouteInfo.totalDescription;
Console.WriteLine("Description1 in TotalDescription : " +
mySegDescription.description1);

For myRouteStop, see RouteStop

For myRouteFinderOptions, see RouteFinderOptions

For token, see getToken

RouteOptions {

filterExtent: Envelope

filterExtent contains the extent for the returned map. It is useful if only part of the route needs to be displayed in a map. Driving directions for the entire route are returned if RouteFinderOptions.returnDirections is set to "true".

hwyPref: integer

hwyPref contains the preference for using highways. Highway preference is defined with a value 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".

precision: double

precision sets 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. The larger the value, 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.

returnEnvelopes: boolean

returnEnvelopes contains an envelope of all segments used in the route. Default is "false".

routeType: string

routeType contains the route searching criteria for using either the quickest or shortest route. 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. The valid content words are "quickest" and "shortest". Default value is "quickest". When using "shortest", hwyPref is not used.

}

Example (Java)

Envelope myEnvelope = new Envelope();
myEnvelope.maxx = -117.1;
myEnvelope.maxy = 34.2;
myEnvelope.minx = -117.2;
myEnvelope.miny = 33.8;

RouteOptions myRouteOptions = new RouteOptions();
myRouteOptions.routeType = "quickest";
myRouteOptions.hwyPref = 100;
myRouteOptions.returnEnvelopes = true;
myRouteOptions.filterExtent = myEnvelope;
myRouteOptions.precision = 1.0;

Example (VB.NET)

Dim myEnvelope As New Envelope()
myEnvelope.maxx = -117.1
myEnvelope.maxy = 34.2
myEnvelope.minx = -117.2
myEnvelope.miny = 33.8

Dim myRouteOptions As New RouteOptions() myRouteOptions.routeType = "quickest"
myRouteOptions.hwyPref = 100
myRouteOptions.returnEnvelopes = True
myRouteOptions.filterExtent = myEnvelope
myRouteOptions.precision = 1.0

Example (C#.NET)

Envelope myEnvelope = new Envelope();
myEnvelope.maxx = -117.1;
myEnvelope.maxy = 34.2;
myEnvelope.minx = -117.2;
myEnvelope.miny = 33.8;

RouteOptions myRouteOptions = new RouteOptions(); myRouteOptions.routeType = "quickest";
myRouteOptions.hwyPref = 100;
myRouteOptions.returnEnvelopes = true;
myRouteOptions.filterExtent = myEnvelope; myRouteOptions.precision = 1.0;

RouteStop {

description: string

point: Point

point contains the x,y coordinate and the coordinate system of the stop. The output is projection "4326" regardless of what you set in point.

}

Example (Java)

RouteStop[] myRouteStop = new RouteStop[2];
RouteStop myRouteStop1 = new RouteStop();
RouteStop myRouteStop2 = new RouteStop();

//Defining Route Start
myRouteStop1.x = -117.18371;
myRouteStop1.y = 34.07383;
myRouteStop1.description = "106 W Pennsylvania Ave, Redlands, CA";

//Defining Route Stop
myRouteStop2.x = -117.195533;
myRouteStop2.y = 34.057055;
myRouteStop2.description = "380 New York St, Redlands, CA 92373";

myRouteStop[0] = myRouteStop1;
myRouteStop[1] = myRouteStop2;

Example (VB.NET)

Dim myRouteStop(1) As RouteStop
Dim myRouteStop1 As New RouteStop()
Dim myRouteStop2 As New RouteStop()
Dim myPoint1 As New Point()
Dim myPoint2 As New Point()

'Defining Route Start
myPoint1.x = -117.18371
myPoint1.y = 34.07383
myRouteStop1.point = myPoint1
myRouteStop1.description = "106 W Pennsylvania Ave, Redlands, CA"

'Defining Route Stop
myPoint2.x = -117.195533
myPoint2.y = 34.057055
myRouteStop2.point = myPoint2
myRouteStop2.description = "380 New York St, Redlands, CA 92373"
myRouteStop(0) = myRouteStop1
myRouteStop(1) = myRouteStop2

Example (C#.NET)

RouteStop[] myRouteStop = new RouteStop[2];
RouteStop myRouteStop1 = new RouteStop();
RouteStop myRouteStop2 = new RouteStop();
Point myPoint1 = new Point();
Point myPoint2 = new Point();

myPoint1.x = -117.18371;
myPoint1.y = 34.07383;
myRouteStop1.point = myPoint1;
myRouteStop1.description = "106 W Pennsylvania Ave, Redlands, CA";

myPoint2.x = -117.195533;
myPoint2.y = 34.057055;
myRouteStop2.point = myPoint2;
myRouteStop2.description = "380 New York St, Redlands, CA 92373";

myRouteStop[0] = myRouteStop1;
myRouteStop[1] = myRouteStop2;

RowData {

fieldValues: string[]

fieldValues contains values for each of the fields in 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 the field value for FieldDesc[0]
fieldValue[1] corresponds to the field value for FieldDesc[1]
fieldValue[2] corresponds to the field value for FieldDesc[2]
fieldValue[3] corresponds to the field value for FieldDesc[3]

}

Example (Java)

myFieldDesc = myResultSet.fields;
myRowData = myResultSet.rows;
System.out.println(myFieldDesc[0].fieldName + " : " + myRowData[0].fieldValues[0]);

For myFieldDesc and myRowData, see ResultSet

Example (VB.NET)

myFieldDesc = myResultSet.fields
myRowData = myResultSet.rows
Console.WriteLine(myFieldDesc(0).fieldName & " : " & myRowData(0).fieldValues(0))

For myFieldDesc and myRowData, see ResultSet

Example (C#.NET)

myFieldDesc = myResultSet.fields;
myRowData = myResultSet.rows;
Console.WriteLine(myFieldDesc[0].fieldName + " : " + myRowData[0].fieldValues[0]);

For myFieldDesc and myRowData, see ResultSet

SegDescription {

description1 contains the first line describing a segment of the route, for example, "Turn left on W Redlands Blvd 0.25572 miles".

distance: double

distanceUnits: string

segmentExtent: Envelope

time: double

time contains the estimated time in minutes of the route segment.

}

IRouteFinder myRouteFinder = RouteFinderHelper.bind();
RouteInfo myRouteInfo = myRouteFinder.findRoute(myRouteStop,myRouteFinderOptions,token);

// Get the segment for the route
SegDescription mySegDescription = myRouteInfo.segDescriptions[0];
System.out.println("Description1 : " + mySegDescription.description1);
System.out.println("Description2 : " + mySegDescription.description2);
System.out.println("Description3 : " + mySegDescription.description3);
System.out.println("Unit of Distance : " + mySegDescription.distanceUnits);
System.out.println("Distance : " + mySegDescription.distance);
System.out.println("Time : " + mySegDescription.time);

Envelope mySegEnvelope = mySegDescription.segmentExtent;
System.out.println("MaxX : " + mySegEnvelope.maxx);
System.out.println("MaxY : " + mySegEnvelope.maxy);
System.out.println("MinX : " + mySegEnvelope.minx);
System.out.println("MinY : " + mySegEnvelope.miny);

For myRouteOptions, see RouteOptions

For myRouteStop, see RouteInfo

For token, see getToken

Dim myRouteFinder As New RouteFinder()
Dim myRouteInfo As New RouteInfo()
myRouteInfo = myRouteFinder.findRoute(myRouteStop,myRouteFinderOptions,token)

'Get segment for the route
mySegDescription = myRouteInfo.segDescriptions(0)
Console.WriteLine("Description1 : " & mySegDescription.description1)
Console.WriteLine("Description2 : " & mySegDescription.description2)
Console.WriteLine("Description3 : " & mySegDescription.description3)
Console.WriteLine("Unit of Distance : " & mySegDescription.distanceUnits)
Console.WriteLine("Distance : " & mySegDescription.distance)
Console.WriteLine("Time : " & mySegDescription.time)

Dim mySegEnvelope As New Envelope()
mySegEnvelope = mySegDescription.segmentExtent
Console.WriteLine("MaxX : " & mySegEnvelope.maxx)
Console.WriteLine("MaxY : " & mySegEnvelope.maxy)
Console.WriteLine("MinX : " & mySegEnvelope.minx)
Console.WriteLine("MinY : " & mySegEnvelope.miny)

For myRouteOptions, see RouteOptions

For myRouteStop, see RouteInfo

For token, see getToken

RouteFinder myRouteFinder = new RouteFinder();
RouteInfo myRouteInfo = myRouteFinder.findRoute(myRouteStop,myRouteFinderOptions,token);

// Get segment for the route
SegDescription mySegDescription = myRouteInfo.segDescriptions[0];
Console.WriteLine("Description1 : " + mySegDescription.description1);
Console.WriteLine("Description2 : " + mySegDescription.description2);
Console.WriteLine("Description3 : " + mySegDescription.description3);
Console.WriteLine("Unit of Distance : " + mySegDescription.distanceUnits);
Console.WriteLine("Distance : " + mySegDescription.distance);
Console.WriteLine("Time : " + mySegDescription.time);

Envelope mySegEnvelope = mySegDescription.segmentExtent;
Console.WriteLine("MaxX : " + mySegEnvelope.maxx);
Console.WriteLine("MaxY : " + mySegEnvelope.maxy);
Console.WriteLine("MinX : " + mySegEnvelope.minx);
Console.WriteLine("MinY : " + mySegEnvelope.miny);

For myRouteOptions, see RouteOptions

For myRouteStop, see RouteInfo

For token, see getToken

Service {

accessUrl: string

accessUrl contains the URL for accessing the ArcWeb Service.

desc: string

name: string

type: string

type contains the type of serviceRestricted or Publicof the ArcWeb Service.

}

Example (Java)

IAccountInfo myAccountInfo = AccountInfoHelper.bind() ;
UserInfo myUserInfo = myAccountInfo.getUserInfo(strToken);
Group[] myGroups = myUserInfo.groups;
for (int i = 0; i < myGroups.length; i++)
{
System.out.println(myGroups[i].name + "- " + myGroups[i].desc);
Service[] myServices = myGroups[i].services;
System.out.println("Available Services:");
for (int j = 0; j < myServices.length; j++)
{
System.out.println(" " + myServices[i].name + "- " + myServices[j].desc);
System.out.println(" " + myServices[i].type + "- " +myServices[j].accessUrl);
}
}

Example (VB.NET)

Dim myAccountInfo As New AccountInfo()
Dim myUserInfo As New UserInfo()
Dim myGroups() As Group
Dim myServices() As Service
Dim i As Integer
Dim j As Integer
myUserInfo = myAccountInfo.getUserInfo(token)
myGroups = myUserInfo.groups
For i = 0 to (myGroups.Length - 1)
Console.WriteLine(myGroups(i).name & "- " & myGroups(i).desc)
myServices = myGroups(i).services
Console.WriteLine("Available Services:")
For j = 0 to (myServices.Length - 1)
Console.WriteLine(" " & myServices(j).name & "- " & myServices(j).desc)
Console.WriteLine(" " & myServices(j).type & "- " & myServices(j).accessUrl)
Next
Next

Example (C#.NET)

AccountInfo myAccountInfo = new AccountInfo();
UserInfo myUserInfo = new UserInfo();
int i;
int j;
myUserInfo = myAccountInfo.getUserInfo(token);
Group[] myGroups = myUserInfo.groups;
for (i = 0; i < myGroups.Length; i++)
{
Console.WriteLine(myGroups[i].name + "- " + myGroups[i].desc);
Service[] myServices = myGroups[i].services;
Console.WriteLine("Available Services:");
for (j = 0; j < myServices.Length; j++)
{
Console.WriteLine(" " + myServices[i].name + "- " & myServices[j].desc);
Console.WriteLine(" " + myServices[i].type + "- " &
myServices[j].accessUrl);
}
}

ServiceDataSourceInfo {

dataSource: string

dataSource contains the name of the data source.

service: string

service contains the name of the ArcWeb Service.

stats: UsageStats

stats contains information about the ArcWeb Service and the data source.

}

IAccountInfo myAccountInfo = AccountInfoHelper.bind();
ServiceDataSourceInfo myServiceDataSourceInfo = myAccountInfo.getServiceDataSourceInfo("ArcWebForDev","AddressFinder",
"GDT.Streets.US", token);
System.out.println("Source: " + myServiceDataSourceInfo.dataSource);
System.out.println("Service: " + myServiceDataSourceInfo.service);
System.out.println("Usage: " + myServiceDataSourceInfo.stats.usage);

Dim myAccountInfo As New AccountInfo()
Dim myServiceDataSourceInfo As New ServiceDataSourceInfo()
myServiceDataSourceInfo = myAccountInfo.getServiceDataSourceInfo("ArcWebForDev", "AddressFinder", "GDT.Streets.US", token)
Console.WriteLine("Source: " & myServiceDataSourceInfo.dataSource)
Console.WriteLine("Service: " & myServiceDataSourceInfo.service)
Console.WriteLine("Usage: " & myServiceDataSourceInfo.stats.usage.ToString())

AccountInfo myAccountInfo = new AccountInfo();
ServiceDataSourceInfo myServiceDataSourceInfo = new ServiceDataSourceInfo();
myServiceDataSourceInfo = myAccountInfo.getServiceDataSourceInfo("ArcWebForDev", "AddressFinder", "GDT.Streets.US", token);
Console.WriteLine("Source: " + myServiceDataSourceInfo.dataSource);
Console.WriteLine("Service: " + myServiceDataSourceInfo.service);
Console.WriteLine("Usage: " + myServiceDataSourceInfo.stats.usage.ToString());

SimplePoint {

x: double

x contains the x coordinate of the point.

y: double

y contains the y coordinate of the point.

}

Example (Java)

SimplePoint mySimplePoint = new SimplePoint();
mySimplePoint.x = -117.199577;
mySimplePoint.y = 34.048364;

Example (VB.NET)

Dim mySimplePoint As New SimplePoint()
mySimplePoint.x = -117.199577
mySimplePoint.y = 34.048364

Example (C#.NET)

SimplePoint mySimplePoint = new SimplePoint();
mySimplePoint.x = -117.199577;
mySimplePoint.y = 34.048364;

Site {

calcType: string

calcType contains the type of rings. Valid values are "solid" or "hollow". Default value is "solid". Note: Only used with method getSiteReports.

polygons: Geometry[]

polygons contains the areas of the report. Note: Site can contain polygons or ringRadii but not both.

ringRadii: double[]

ringRadii contains the radii of the rings. Note: Site can contain ringRadii or polygons but not both.

ringUnits: string

RingUnits contains the units of the ring's radius. Possible values are "miles" or "km". The default value is "miles".

siteLocation:  Point

siteLocation contains the x,y coordinates of the site. It is 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: sting

siteName contains a label for the map.

}

Example (Java)

Site mySite = new Site();
mySite.calcType = "hollow";
mySite.ringUnits = "km";
mySite.siteLocation = myPoint;
mySite.siteName = "Sample site";
double[] myRingRadii = new double[2];
myRingRadii[0] = 5.0;
myRingRadii[1] = 10.0;
mySite.ringRadii = myRingRadii;

For myPoint, see Point

Example (VB.NET)

Dim mySite As New Site()
mySite.calcType = "hollow"
mySite.ringUnits = "km"
mySite.siteLocation = myPoint
mySite.siteName = "Sample site"
Dim myRingRadii(1) As Double
myRingRadii(0) = 5
myRingRadii(1) = 10
mySite.ringRadii = myRingRadii

For myPoint, see Point

Example (C#.NET)

Site mySite = new Site();
mySite.calcType = "hollow";
mySite.ringUnits = "km";
mySite.siteLocation = myPoint;
mySite.siteName = "Sample site";
Double[] myRingRadii = new Double[2];
myRingRadii[0] = 5;
myRingRadii[1] = 10;
mySite.ringRadii = myRingRadii;

For myPoint, see Point

StandardGeography {

geographyIds: string[]

geographyIds contains the geographic ID for the site. Use method getGeographyIds to get valid values. Default value is "null".

geographyLevel: string

geographyLevel contains the geographic level at which the data is returned. Valid values are "BlockGroup", "CBSA", "Congressional Districts", "County", "County SubDivisions", "DMA", "Place", "State", "Tract", and "Zip". Default value is "null".

}

Example (Java)

StandardGeography myStandardGeography[] = new StandardGeography[2];
StandardGeography myStandardGeography1 = new StandardGeography();
StandardGeography myStandardGeography2 = new StandardGeography();
myStandardGeography1.geographyLevel = "Zip";
String[] geographyIds1 = new String[1];
geographyIds1[0] = "92373" ;
myStandardGeography1.geographyIds = geographyIds1;
String[] geographyIds2 = new String[1];
geographyIds2[0] = "06" ;
myStandardGeography2.geographyLevel = "State";
myStandardGeography2.geographyIds = geographyIds2;
myStandardGeography[0] = myStandardGeography1;
myStandardGeography[1] = myStandardGeography2;

Example (VB.NET)

Dim myStandardGeography(1) As StandardGeography
Dim myStandardGeography1 As New StandardGeography()
Dim myStandardGeography2 As New StandardGeography()
myStandardGeography1.geographyLevel = "Zip"
Dim geographyIds1(0) as String
geographyIds1(0)="92373"
myStandardGeography1.geographyIds = geographyIds1
myStandardGeography2.geographyLevel = "State"
Dim geographyIds2(0) as String
geographyIds2(0)="06"
myStandardGeography2.geographyIds = geographyIds2
myStandardGeography(0) = myStandardGeography1
myStandardGeography(1) = myStandardGeography2

Example (C#.NET)

StandardGeography[] myStandardGeography = new StandardGeography[2];
StandardGeography myStandardGeography1 = new StandardGeography();
StandardGeography myStandardGeography2 = new StandardGeography();
myStandardGeography1.geographyLevel = "Zip";
String[] geographyIds1 = new String[1];
geographyIds1[0] = "92373" ;
myStandardGeography1.geographyIds = geographyIds1;
String[] geographyIds2 = new String[1];
geographyIds2[0] = "06" ;
myStandardGeography2.geographyLevel = "State";
myStandardGeography2.geographyIds = geographyIds2;
myStandardGeography[0] = myStandardGeography1;
myStandardGeography[1] = myStandardGeography2;

ThematicOptions {

classColors: string[]

classColors contains the color to use for each class break. Color style is defined as an R,G,B string with each value between 0 and 255, for example, ("255,0,0") is red. Use either colorPalette or classColors but not both. Default value is null.

classificationMethod: string

classificationMethod contains information about how the data classes are divided. Possible 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.

classLabels: string[]

classLabels contains labels for each class in the legend. The order of the classLabels values needs to match up with the order of the legend.

codeColorValues: KeyValue[]

codeColorValues contains the key/value pair for number and color. This parameter is used to "color-code" data such as ZIP Codes. Default value is null. It is necessary to define codeColorValues if you use your own data and define your own classifications and their color values. For more information, see thematic option #3 in Map Image notes. Otherwise, Map Image Web Service assumes the value in the thematicData parameter is related to data (and not key/value) and calculates breaks based on the content. For more information, see thematic option #2 in Map Image notes. The order of codeColorValues values determines the order of the legend.

colorPalette: string

colorPalette contains a color ramp for the class breaks.  Use either colorPalette or classColors but not both. Possible values are "blue", "coldToHot", "green", "grey", "orange", or "red". Default value is "red". colorPalette is ignored if you use codeColorValues.

geographyLevel: string

geographyLevel contains the geographic level in which the map displays. Use getThematicGeographiesForExtent method to see the possible geography levels for a given data source. Default value is the most detailed geography level for the given extent.

numberOfClasses: integer

numberOfClasses contains the number of classes into which the data is classified. Default value is "2". numberOfClasses is ignored if you use codeColorValues.

showOnlyThematicInLegend: boolean

showOnlyThematicInLegend determines whether or not only the thematic layers are shown in the legend. Default value is "false" (i.e., all layers appear in the legend).

}

Example (Java)

ThematicOptions myThematicOptions = new ThematicOptions();
myThematicOptions.showOnlyThematicInLegend = false;
myThematicOptions.numberOfClasses = 2;
myThematicOptions.classificationMethod = "equalInterval";
myThematicOptions.colorPalette = "green";
myThematicOptions.geographyLevel = "zip";
String[] myClassLabels = new String[2];
myClassLabels[0] = "Group One";
myClassLabels[1] = "Group two";
myThematicOptions.classLabels = myClassLabels;

Example (VB.NET)

Dim myThematicOptions As New ThematicOptions()
myThematicOptions.showOnlyThematicInLegend = false
myThematicOptions.numberOfClasses = 2
myThematicOptions.classificationMethod = "equalInterval"
myThematicOptions.colorPalette = "green"
myThematicOptions.geographyLevel = "zip"
Dim myClassLabels as New String(1)
myClassLabels(0) = "Group One"
myClassLabels(1) = "Group Two"
myThematicOptions.classLabels = myClassLabels

Example (C#.NET)

myThematicOptions = new ThematicOptions();
myThematicOptions.showOnlyThematicInLegend = false;
myThematicOptions.numberOfClasses = 2;
myThematicOptions.classificationMethod = "equalInterval";
myThematicOptions.colorPalette = "green";
myThematicOptions.geographyLevel = "zip";
string[] myClassLabels = new string[1];
myClassLabels[0] = "Group One";
myClassLabels[1] = "Group Two";
myThematicOptions.classLabels = myClassLabels;

ThematicReportOptions {

}

ThematicReportOptions myThematicReportOptions = new ThematicReportOptions();
myThematicReportOptions.classificationMethod = "quantile";
myThematicReportOptions.colorPalette = "grey";
myThematicReportOptions.geographyLevel = "zip";
myThematicReportOptions.numberOfClasses = 3;

Dim myThematicReportOptions As New ThematicReportOptions()
myThematicReportOptions.classificationMethod = "quantile"
myThematicReportOptions.colorPalette = "grey"
myThematicReportOptions.geographyLevel = "zip"
myThematicReportOptions.numberOfClasses = 3

ThematicReportOptions myThematicReportOptions = new ThematicReportOptions();
myThematicReportOptions.classificationMethod = "quantile";
myThematicReportOptions.colorPalette = "grey";
myThematicReportOptions.geographyLevel = "zip";
myThematicReportOptions.numberOfClasses = 3;

ThematicVariableInfo {

database: string

database contains the name of the database containing the variable.

shortDesc: string

shortDesc contains a short description of the variable.

table: string

table contains the name of the table containing the variable.

variable: string

variable contains the name of the variable.

}

Example (Java)

IReport myReport = ReportHelper.bind();
ThematicVariableInfo[] myThematicVariableInfo = myReport.getThematicVariables("2004/2009 Demographics", "2004 Household Income");
System.out.println("Database : " + myThematicVariableInfo[0].database);
System.out.println("Table: " + myThematicVariableInfo[0].table);
System.out.println("First variable name: " + myThematicVariableInfo[0].variable);
System.out.println("First short description : " + myThematicVariableInfo[0].shortDesc);

Example (VB.NET)

Dim myReport As New Report()
Dim myThematicVariableInfo As New ThematicVariableInfo()
myThematicVariableInfo = myReport.getThematicVariables("2004/2009 Demographics", "2004 Household Income")
Console.WriteLine("Database: " & myThematicVariableInfo(0).database)
Console.WriteLine("Table: " & myThematicVariableInfo(0).table)
Console.WriteLine("Variable name: " & myThematicVariableInfo(0).variable)
Console.WriteLine("Short description: " & myThematicVariableInfo(0).shortDesc)

Example (C#.NET)

Report myReport = new Report();
ThematicVariableInfo[] myThematicVariableInfo = myReport.getThematicVariables("2004/2009 Demographics", "2004 Household Income");
Console.WriteLine("Database : " + myThematicVariableInfo[0].database);
Console.WriteLine("Table: " + myThematicVariableInfo[0].table);
Console.WriteLine("First variable name: " + myThematicVariableInfo[0].variable);
Console.WriteLine("First short description : " + myThematicVariableInfo[0].shortDesc);

UsageStats {

dailyAve: long

dailyAve contains the average credit usage over a 30-day period beginning with the first day a credit was used. See Account Info notes for more information.

pastDay: long

pastDay contains the number of credits used in the past 24 hours that the data source, service, and/or ArcWeb Services group.

pastMonth: long

pastMonth contains the number of credits used in the past 30 days that the data source, service, and/or ArcWeb Services group has been accessed.

pastWeek: long

pastWeek contains the number of credits used in the past seven days that the data source, service, and/or ArcWeb Services group has been accessed.

pastYear: long

pastYear contains the number of credits used in the past 365 days that the data source, service, and/or ArcWeb Services group has been accessed.

percent: integer

percent contains the percentage of credits that the data source, service, and/or ArcWeb Services group has used as the data source, service, or group when a request has been made.

usage: long

usage contains the number of credits the data source, service, or ArcWeb Services group has been used since the user account was activated.

}

Example (Java)

IAccountInfo myAccountInfo = AccountInfoHelper.bind() ;
DataSourceInfo myDataSourceInfo = myAccountInfo.getDataSourceInfo("GDT.Streets.US", token);

System.out.println("Daily Avg. Use: " + myDataSourceInfo.stats.dailyAvg);
System.out.println("Use in past day: " + myDataSourceInfo.stats.pastDay);
System.out.println("Use in past week: " + myDataSourceInfo.stats.pastWeek);
System.out.println("Use in past month: " + myDataSourceInfo.stats.pastMonth);
System.out.println("Use in past year: " + myDataSourceInfo.stats.pastYear);
System.out.println("% of requests sent to this data source: " + myDataSourceInfo.stats.percent);
System.out.println("Total requests sent to this data source: " + myDataSourceInfo.stats.usage);

Example (VB.NET)

Dim myAccountInfo As New AccountInfo()
Dim myDataSourceInfo As New DataSourceInfo()
myDataSourceInfo = myAccountInfo.getDataSourceInfo("GDT.Streets.US", token)
Console.WriteLine("Daily Avg. Use: " & myDataSourceInfo.stats.dailyAveUse.ToString())
Console.WriteLine("Use in past day: " & myDataSourceInfo.stats.pastDay.ToString())
Console.WriteLine("Use in past week: " & myDataSourceInfo.stats.pastWeek.ToString())
Console.WriteLine("Use in past month: " & myDataSourceInfo.stats.pastMonth.ToString())
Console.WriteLine("Use in past year: " & myDataSourceInfo.stats.pastYear.ToString())
Console.WriteLine("% of requests sent to this data source: " & myDataSourceInfo.stats.percent.ToString())
Console.WriteLine("Total requests sent to this data source: " & myDataSourceInfo.stats.usage.ToString())

Example (C#.NET)

AccountInfo myAccountInfo = new AccountInfo();
DataSourceInfo myDataSourceInfo = new DataSourceInfo();
myDataSourceInfo = myAccountInfo.getDataSourceInfo("GDT.Streets.US", token);
Console.WriteLine("Daily Avg. Use: " + myDataSourceInfo.stats.dailyAveUse.ToString());
Console.WriteLine("Use in past day: " + myDataSourceInfo.stats.pastDay.ToString());
Console.WriteLine("Use in past week: " + myDataSourceInfo.stats.pastWeek.ToString());
Console.WriteLine("Use in past month: " + myDataSourceInfo.stats.pastMonth.ToString());
Console.WriteLine("Use in past year: " + myDataSourceInfo.stats.pastYear.ToString());
Console.WriteLine("% of requests sent to this data source: " + myDataSourceInfo.stats.percent.ToString());
Console.WriteLine("Total requests sent to this data source: " + myDataSourceInfo.stats.usage.ToString());