Report Web Service methods

getAvailableFieldNames:(reportOptions:ReportOptions):FieldDesc[]

getDatabases:string[]

getGeographyIds(geographyIdOptions:GeographyIdOptions):ResultSet

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

getReportHeaderKeys:(methodName:string):KeyValue[]

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

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

getTables(database:string):string[]

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

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

getVersion:string

searchThematicVariables(keyword:string): ThematicVariableInfo[]

Method Name

getAvailableFieldNames

Description

Returns information about available fields for a specific data source.

Endpoint URL

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

Input Parameters

reportOptions

ReportOptions

Valid Arguments

reportOptions

See parameter descriptions in ReportOptions.

Output Parameter

Result

FieldDesc [] containing array of available field names and field descriptions.

Example (Java)

IReport myReport = ReportHelper.bind();
FieldDesc[] myFieldDesc = myReport.getAvailableFieldNames(myReportOptions);

For myReportOptions, see ReportOptions.

Example (VB.NET)

Dim myReport As New Report()
Dim myFieldDesc As FieldDesc()
myFieldDesc = myReport.getAvailableFieldNames(myReportOptions)

For myReportOptions, see ReportOptions.

Example (C#.NET)

Report myReport = new Report();
FieldDesc[] myFieldDesc = myReport.getAvailableFieldNames(myReportOptions);

For myReportOptions, see ReportOptions.

Method Name

getDatabases

Description

Returns a list of databases that can be used to create a thematic map report. Use the output of getDatabases as the input for the method getTables.

Endpoint URL

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

Output Parameter

Result

string[]

Example (Java)

IReport myReport = ReportHelper.bind();
String[] myDataBases = myReport.getDatabases();

Example (VB.NET)

Dim myReport As New Report()
Dim myDataBases() As String
myDataBases = myReport.getDatabases()

Example (C#.NET)

Report myReport = new Report();
string[] myDataBases = myReport.getDatabases();

Method Name

getGeographyIds

Description

Returns geography ID information.

Endpoint URL

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

Input Parameters

geographyIdOptions

GeographyIdOptions

Valid Arguments

geographyIdOptions

See parameter descriptions in GeographyIdOptions.

Output Parameter

Result

ResultSet containing ID and NAME.

Example (Java)

IReport myReport = ReportHelper.bind();
ResultSet myGeographyIds = myReport.getGeographyIds(myGeographyIdOptions)

For myGeographyIdOptions, see GeographyIdOptions.

Example (VB.NET)

Dim myReport As New Report()
Dim myGeographyIds As New ResultSet()
myGeographyIds = myReport.getGeographyIds(myGeographyIdOptions)

For myGeographyIdOptions, see GeographyIdOptions.

Example (C#.NET)

Report myReport = new Report();
Dim myGeographyIds As New ResultSet()
myGeographyIds = myReport.getGeographyIds(myGeographyIdOptions)

For myGeographyIdOptions, see GeographyIdOptions.

Method Name

getMapReport

Description

Returns a map report in PDF format for a specified array of sites.

Endpoint URL

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

Input Parameters

sites	Site[]
reportOptions	ReportOptions
token	string

Valid Arguments

sites	See parameter descriptions in Site.
reportOptions	See parameter descriptions in ReportOptions.
token	Authentication token

Output Parameter

Result

ReportInfo

Example (Java)

IReport myReport = ReportHelper.bind();
Site mySites[] = new Site[1];
mySites[0] = mySite;
ReportInfo myMapReport = myReport.getMapReport(mySites, myReportOptions, token);

For myReportOptions, see ReportOptions.

For mySite, see Site.

Example (VB.NET)

Dim myReport As New Report()
Dim mySites(0) as Site
mySites(0) = mySite
Dim myMapReport As New ReportInfo()
myMapReport = myReport.getMapReport(mySites, myReportOptions, token)

For myReportOptions, see ReportOptions.

For mySite, see Site.

Example (C#.NET)

Report myReport = new Report();
Site[] mySites = new Site[1];
mySites[0] = mySite;
ReportInfo myMapReport = myReport.getMapReport(mySites, myReportOptions, token);

For myReportOptions, see ReportOptions.

For mySite, see Site.

Method Name

getReportHeaderKeys

Description

Returns the key/value pairs for the header of the report based on the method name.

Method Namespace URI

http://arcweb.esri.com/v2/Report

Input Parameter

methodName

string

Valid Arguments

methodName

"getMapReport", "getSiteReport", "getStandardGeographyReport", or "getThematicMapReport".

Output Parameter

Result

KeyValue[]

Example (Java)

IReport myReport = ReportHelper.bind();
KeyValue[] myReportHeaderKeys = myReport.getReportHeaderKeys("getMapReport");
System.out.println("First Key : "+ myReportHeaderKeys[0].key);
System.out.println("First Value : "+ myReportHeaderKeys[0].value);

Example (VB.NET)

Dim myReport As New Report()
Dim myReportHeaderKeys() As KeyValue
myReportHeaderKeys = myReport.getReportHeaderKeys("getMapReport")
Console.WriteLine("First Key : " + myReportHeaderKeys(0).key)
Console.WriteLine("First Value : " + myReportHeaderKeys(0).value)

Example (C#.NET)

Report myReport = new Report();
KeyValue[] myReportHeaderKeys = myReport.getReportHeaderKeys("getMapReport");
Console.WriteLine("First Key : "+ myReportHeaderKeys[0].key);
Console.WriteLine("First Value : "+ myReportHeaderKeys[0].value);

Method Name

getSiteReports

Description

Returns pre-formatted reports for a specified site.

Endpoint URL

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

Input Parameters

site	Site
reportOptions	ReportOptions[]
combineReports	boolean
token	string

Valid Arguments

site	See parameter descriptions in Site.
reportOptions	See parameter descriptions in ReportOptions. Note: You are charged for each data source you use in this array.
combineReports	"true" means data sources are combined into one PDF report; "false" means each data source is returned as a separate PDF report. Note: Valid with PDF reports only.
token	Authentication token

Output Parameter

Result

ReportInfo[]

Example (Java)

IReport myReport = ReportHelper.bind();
ReportOptions myReportOptionsArray[] = new ReportOptions[1];
myReportOptionsArray[0] = myReportOptions;
ReportInfo[] mySiteReports = myReport.getSiteReports(mySite, myReportOptionsArray, true, token);

For myReportOptions, see ReportOptions.

For mySite, see Site.

Example (VB.NET)

Dim myReport As New Report()
Dim myReportOptionsArray(0) as ReportOptions
myReportOptionsArray(0) = myReportOptions
Dim mySiteReports() As ReportInfo
mySiteReports = myReport.getSiteReports(mySite, myReportOptionsArray, True, token)

For myReportOptions, see ReportOptions.

For mySite, see Site.

Example (C#.NET)

Report myReport = new Report();
ReportOptions[] myReportOptionsArray = new ReportOptions[1];
myReportOptionsArray[0] = myReportOptions;
ReportInfo[] mySiteReports = myReport.getSiteReports(mySite, myReportOptionsArray, True, token);

For myReportOptions, see ReportOptions.

For mySite, see Site.

Method Name

getStandardGeographyReport

Description

Returns a pre-formatted report for specified standard geographies.

Endpoint URL

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

Input Parameters

standardGeographies	StandardGeography[]
reportOptions	ReportOptions
token	string

Valid Arguments

standardGeographies	See parameter descriptions in StandardGeography.
reportOptions	See parameter descriptions in ReportOptions.
token	Authentication token

Output Parameter

Result

ReportInfo

Example (Java)

IReport myReport = ReportHelper.bind();
ReportInfo myStandardGeographyReport = myReport.getStandardGeographyReport(myStandardGeography, myReportOptions, token);

For myReportOptions, see ReportOptions.

For myStandardGeography, see StandardGeography.

Example (VB.NET)

Dim myReport As New Report()
Dim myStandardGeographyReport As New ReportInfo()
myStandardGeographyReport = myReport.getStandardGeographyReport(myStandardGeography, myReportOptions, token)

For myReportOptions, see ReportOptions.

For myStandardGeography, see StandardGeography.

Example (C#.NET)

Report myReport = new Report();
ReportInfo myStandardGeographyReport = myReport.getStandardGeographyReport(myStandardGeography, myReportOptions, token);

For myReportOptions, see ReportOptions.

For myStandardGeography, see StandardGeography.

Method Name

getTables

Description

Returns a list of tables for a specific database that can be used to create a thematic map report. Use the output of getTables as an input for the method getThematicVariables.

Endpoint URL

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

Input Parameters

database

string

Valid Arguments

database

Use method getDatabases to see a list of possible values.

Output Parameter

Result

string[]

Example (Java)

IReport myReport = ReportHelper.bind();
String[] myTables = myReport.getTables("2004/2009 Demographics");

Example (VB.NET)

Dim myReport As New Report()
Dim myTables() As String
myTables = myReport.getTables("2004/2009 Demographics")

Example (C#.NET)

Report myReport = new Report();
string[] myTables = myReport.getTables("2004/2009 Demographics");

Method Name

getThematicMapReport

Description

Returns a thematic map in PDF format for a specified array of sites.

Endpoint URL

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

Input Parameters

sites	Site[]
reportoptions	ReportOptions
thematicReport Options	ThematicReportOptions
thematicVariable	string
token	string

Valid Arguments

sites	See parameter descriptions in Site.
reportOptions	See parameter descriptions in ReportOptions.
thematicOptions	See parameter descriptions in ThematicOptions.
thematicVariable	See value from parameter variable in object ThematicVariableInfo.
token	Authentication token

Output Parameter

Result

ReportInfo

Example (Java)

IReport myReport = ReportHelper.bind();
Site mySites[] = new Site[1];
mySites[0] = mySite ;
ReportInfo myReportInfo = myReport.getThematicMapReport(mySites, myReportOptions, myThematicReportOptions, "HINC75_CY", token);

For mySite, see Site.

For myReportOptions, see ReportOptions.

For myThematicReportOptions, see ThematicReportOptions.

Example (VB.NET)

Dim myReport As New Report()
Dim mySites(0) as Site
mySites(0) = mySite
Dim myThematicMapReport As New ReportInfo()
myThematicMapReport = myReport.getThematicMapReport(mySites, myReportOptions, myThematicReportOptions, "HINC75_CY", token)

For mySite, see Site.

For myReportOptions, see ReportOptions.

For myThematicReportOptions, see ThematicReportOptions.

Example (C#.NET)

IReport myReport = ReportHelper.bind();
Site mySites[] = new Site[1];
mySites[0] = mySite;
ReportInfo myReportInfo = myReport.getThematicMapReport(mySites, myReportOptions, myThematicReportOptions, "HINC75_CY", token);

For mySite, see Site.

For myReportOptions, see ReportOptions.

For myThematicReportOptions, see ThematicReportOptions.

Method Name

getThematicVariables

Description

Returns a list of variables for a specified database and table. Use the output of getThematicVariables as an input for the method getThematicMapReport.

Endpoint URL

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

Input Parameters

database	string
tableName	string

Valid Arguments

database	Use method getDatabases for valid database names.
tableName	Use method getTables for valid table names for a given database.

Output Parameter

Result

ThematicVariableInfo[]

Example (Java)

IReport myReport = ReportHelper.bind();
ThematicVariableInfo[] myVariables = myReport.getThematicVariables("2004/2009 Demographics", "2004 Household Income");

Example (VB.NET)

Dim myReport As New Report()
Dim myVariables() As ThematicVariableInfo
myVariables = myReport.getThematicVariables("2004/2009 Demographics", "2004 Household Income")

Example (C#.NET)

Report myReport = new Report();
ThematicVariableInfo[] myVariables = myReport.getThematicVariables("2004/2009 Demographics", "2004 Household Income");

Method Name

getVersion

Description

Returns the version number of Report Web Service.

Endpoint URL

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

Output Parameter

Result

string

Example (Java)

IReport myReport = ReportHelper.bind();
String version = myReport.getVersion();

Example (VB.NET)

Dim myReport As New Report()
Dim version As String
version = myReport.getVersion()

Example (C#.NET)

Report myReport = new Report();
string version = myReport.getVersion();

Method Name

searchThematicVariables

Description

Returns the thematic variables based on a keyword search. Use the output of searchThematicVariables as an input for the method getThematicMapReport.

Endpoint URL

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

Input Parameter

keyword

string

Valid Argument

keyword

A string with one or more letters. If the string is one or two letters, an exact search for the variable is made. If the string is three or more letters, a search for variables beginning with those letters is made.

Output Parameter

Result

ThematicVariableInfo[]

Example (Java)

IReport myReport = ReportHelper.bind();
ThematicVariableInfo[] myThematicVariableInfo = myReport.searchThematicVariables("social security income");

Example (VB.NET)

Dim myReport As New Report()
Dim myThematicVariableInfo() As ThematicVariableInfo
myThematicVariableInfo = myReport.searchThematicVariables("social security income")

Example (C#.NET)

Report myReport = new Report();
ThematicVariableInfo[] myThematicVariableInfo = myReport.searchThematicVariables("social security income");

Report Web Service methods

See also