You are here: Using SOAP > v2006.1 services > Report > Report v2006.1 methods

Report Web Service v2006.1 methods

To see Report Web Service in action, interact with a live sample of a Report client.

createPDFDocument(templateName:string, data:KeyValue[], token:string):string

getAvailableTemplateNames(token:string):string[]

getCustomSiteReport(site:Site, reportOptions:ReportOptions, variables:CustomReportVariables[], token:string):ReportInfo

getCustomStandardGeographyReport(standardGeographies:StandardGeography[], reportOptions:ReportOptions, variables:CustomReportVariables[], token:string):ReportInfo

getCustomVariables(variableDataSource:string, token:string):CustomVariableInfo[]

getDatabases(token:string):string[]

getGeographyIDs(geographyIDOptions:GeographyIDOptions, token:string):ResultSet

getReportHeaderKeys(methodName:string, token:string):KeyValue[]

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

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

getTables(database:string, token:string):string[]

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

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

getVersion:string

searchThematicVariables(keyword: string, token: string):ThematicVariableInfo[]

createPDFDocument

Returns user-defined data in PDF format.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
templateName	string	Use method getAvailableTemplateNames to get valid values.
data	KeyValue[]	KeyValue parameters where the keys are the variable labels and the values are the data.
token	string	Authentication token

Output

string

Code examples

getAvailableTemplateNames

Returns template names to use with method createPDFDocument.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
token	string	Authentication token

Output

string[]

Code examples

getCustomSiteReport

Returns a report with user-requested variables for a specified site. You will be charged per variable. Use the method getCustomVariables to get a list of available variables.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
site	Site	Site parameters
reportOptions	ReportOptions	ReportOptions parameters
variables	CustomReportVariables[]	CustomReportVariables parameters
token	string	Authentication token

Output

Code examples

getCustomStandardGeographyReport

Returns a report containing user-requested variables for a specified standard geography. You will be charged per variable. Use the method getCustomVariables to get a list of available variables, such as ZIP Code or state.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
standardGeographies	StandardGeography[]	StandardGeography parameters
reportOptions	ReportOptions	ReportOptions parameters
variables	CustomReportVariables[]	CustomReportVariables parameters
token	string	Authentication token

Output

Code examples

getCustomVariables

Returns a list of variables that can be used to create a custom report.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
variableDataSource	string	"ArcWeb:ESRI.Census2000Summary.US", "ArcWeb:ESRI.CEX_AutomotiveAftermarket.US", "ArcWeb:ESRI.CEX_Financial.US", "ArcWeb:ESRI.CEX_HouseAndHome.US", "ArcWeb:ESRI.CEX_HouseholdBudget.US", "ArcWeb:ESRI.CEX_Medical.US", "ArcWeb:ESRI.CEX_Recreation.US", "ArcWeb:ESRI.CEX_RetailGoodsAndServices.US", or "ArcWeb:ESRI.DemographicAndIncome.US". See Service Finder for details about these data sources.
token	string	Authentication token

Output

Code examples

getDatabases

Returns a list of databases, such as Census 2000 or 2006/2011 Demographics, which contain tables of data for thematic mapping, spatial query and report services. Use the output of getDatabases as the input for the method getTables.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
token	string	Authentication token

Output

string[]

Code examples

getGeographyIDs

Returns geography ID information. Use with the method getStandardGeographyReport in the parameter StandardGeography.geographyIDs.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
geographyIDOptions	GeographyIDOptions	GeographyIDOptions parameters
token	string	Authentication token

Output

Code examples

getReportHeaderKeys

Returns the key/value pairs for the header and footer of the report based on the method name. Use with the parameter ReportOptions.reportHeader and with the methods that returns a report (as ReportInfo): getCustomSiteReport, getCustomStandardGeographyReport, getStandardGeographyReport, and getThematicMapReport.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
methodName	string	"getCustomSiteReport", "getCustomStandardGeographyReport", "getStandardGeographyReport", and "getThematicMapReport".
token	string	Authentication token

Output

Code examples

getSiteReports

Returns preformatted reports for a specified site.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
site	Site	Site parameters
reportOptions	ReportOptions[]	ReportOptions parameters
combineReports	boolean	true means data sources are combined into one PDF report; false means each data source is returned as a separate PDF report. Valid with PDF reports only.
token	string	Authentication token

Output

Code examples

getStandardGeographyReport

Returns a preformatted report for specified standard geographies.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
standardGeographies	StandardGeography[]	StandardGeography parameters
reportOptions	ReportOptions	ReportOptions parameters
token	string	Authentication token

Output

Code examples

getTables

Returns a list of tables that contain individual data variables for use in thematic mapping, spatial query, and report services. Use the output of getTables as an input for the method getThematicVariables.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
database	string	Use method getDatabases to get valid values.
token	string	Authentication token

Output

string[]

Code examples

getThematicMapReport

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

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
site	Site	Site parameters
reportOptions	ReportOptions	ReportOptions parameters
thematicReportOptions	ThematicReportOptions	ThematicReportOptions parameters
thematicVariables	string	Use method getThematicVariables to get valid values.
token	string	Authentication token

Output

Code examples

getThematicVariables

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://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
database	string	Use method getDatabases to get valid values.
table	string	Use method getTables to get valid values.
token	string	Authentication token

Output

ThematicVariableInfo[]

Code examples

getVersion

Returns the version number of Report Web Service.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Output

string

Code examples

searchThematicVariables

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

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/Report

Input

Name	Type	Valid values
keyword	string	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.
token	string	Authentication token

Output

ThematicVariableInfo[]

Code examples

Visit the Feedback page to give comments or suggestions about the ArcWeb Developer's Guide.

ArcWeb site | ArcWeb support | support.esri.com