WebServices API Referencence
Tile Request
The Tile webservice allows you to retrieve images. These images can be overlayed
on top of google and virtual earth maps. There are two ways to specify the geographic
bounds of an image. A virtual earth tile id or a geographic bounds can be specified.
Request URL
http://trial.parcelstream.com/VEParcelTileServer.aspx
Request Paramters
|
Parameter |
Value |
Description |
|
TileID |
String |
Virtual Earth TileID. Ex. "0111110111011110" |
|
BBox |
String |
Geographic bounding box of an image. <minx, miny, maxx, maxy> Ex. "33,
-117, 33.1, -116.999" |
|
Format |
String |
Return type of the image. Currently, only png images are supported and is the default.
ex. "image/png" |
|
SLD |
String |
Styled layer descriptor url. A url to an SLD file can be specified to change how
the image is rendered. |
|
SLD_BODY |
String |
Styled layer descriptor text. The sld text can be used to change how the image is
rendered.. |
|
Layers |
String |
A comman delimited list of layers to render. The order in which the layers are specified
are the order in which they are rendered. |
Response
Returns an image if the request is successful.
Errors
- Authentication Failure: Key invalid
- Parameter TileID or BBox not specified.
- Image Generation Error. DMP Internal error.
Geocode
The Geocoding Web Service allows you to find the specific geoemtry, apn, and fips
for an address.
Request URL
http://trial.parcelstream.com/Geocode.aspx
Request Paramters
|
Parameter |
Value |
Description |
|
address |
String |
Unparsed Street Address. {eg: 122 Main St} |
|
city |
String |
City name. |
|
state |
String |
The State name. It can be an abbreviation or fully qualified name. |
|
zip |
String |
The five-digit zip code. |
|
Context Geometry |
String |
a WKT representation of a context geometry. This is an optional starting point to
get the relevent results closest to the Context. |
|
minScore |
int |
The minimum score for the returned results from 0 - 100. The default is 85.
|
|
output |
String |
The output type. If nothing is specified then xml is returned. Otherwise a json
response is returned. If json is specified the obsID, obsSuccessMethodID, and obsErrorMethod
must be specified. |
|
obsID |
String |
Object name to call in the json response. This object will be passed the json object
response. |
|
obsSuccessMethod |
String |
The method to call in the Object when the request is a json request and the response
is sucessful.
|
|
obsErrorMethod |
String |
The method to call in the Object when the request is a json request and the response
is an error.
|
Response Data Field Attributes
|
Parameter |
Value |
Description |
|
DataSource |
String |
The originating source of the data. |
|
ID |
String |
The record unique key identifier. For PARCELS DataSource this ID will be FIPS_APN. |
|
Address |
String |
The first line street address. |
|
City |
String |
The city name |
|
State |
String |
The state name. |
|
Zipcode |
String |
The 5 digit zip code.
|
|
GEOMETRY |
String |
WKT representation of a centroid of a geometry.
|
|
Score |
Int |
A number for 0 - 100 indicating the accuracy of the result. 100 is most accurate
and 0 is least accurate.
|
|
MatchCodes |
String |
For future use.
|
Sample XML Response
http://trial.parcelstream.com/Geocode.aspx?address=21%20jordan%20e.&city=irvine&state=ca&zip=92612
Errors
- Authentication Failure: Key invalid
Query
The Query Webservice allows you to search by apn and fips for a parcel geometry
or search by geometry filter for a list of apn, fips, and geometries contained in
that geometry filter
Request URL
http://trial.parcelstream.com/Query.aspx
Request Paramters
|
Parameter |
Value |
Description |
|
geoFilter |
String |
Well Known Text(WKT) Geometry to filter the results by. |
|
geoBufferDist |
String |
A distance to expand the geometry for a buffered search. |
|
returnGeoType |
String |
The returning geometry type. There are 3 return types.
- 1 = geometry ( the whole geometry is returned)
- 2 = none ( no geometry is returned)
- 3 = centriod ( only centriod)
|
|
DataSource |
String |
The name of the Data Source to query against. |
|
maxRecords |
String |
The maximum number of results to return. |
|
ID |
String |
Unique record identifier of a DataSource.
Ex:For PARCELS DataSource, this is in the form FIPS_APN
http://trial.parcelstream.com/Query.aspx?&returnGeoType=1&ID=06059_36322102&DataSource=PARCELS
|
|
APN (deprecated) |
String |
(Instead use ID and DataSource combination) Address parcel number. If this parameter
is specified with the fips code an apn search is executed.
|
|
FIPS(deprecated) |
String |
(Instead use ID and DataSource combination) The fips code to search in for the apn. |
|
output |
String |
The output type. If nothing is specified then xml is returned. Otherwise a json
response is returned. If json is specified the obsID, obsSuccessMethodID, and obsErrorMethod
must be specified. |
|
obsID |
String |
Object name to call in the json response. This object will be passed the json object
response. |
|
obsSuccessMethod |
String |
The method to call in the Object when the request is a json request and the response
is sucessful.
|
|
obsErrorMethod |
String |
The method to call in the Object when the request is a json request and the response
is an error.
|
Response Data Field Attributes for PARCELS DataSource
|
Parameter |
Value |
Description |
|
GEOMETRY |
String |
Well Known Text(WKT) geometry string.
|
|
APN |
String |
The Address Parcel Number |
|
FIPS |
String |
The county/state identifier. |
|
ID |
String |
The identifier. |
Sample XML Response
http://trial.parcelstream.com/Query.aspx?&returnGeoType=1&geoFilter=POINT(-117.80014157295228%2033.85083318224948)&DataSource=PARCELS
Errors
- Authentication Failure: Key invalid
- APN and Fips not found.
