|
Description
The Address Web Service allows application developers to validate and search the Address Dataset. Once an address
is found, you can lookup the tax property ID and its tax unit. There are also methods to give you all the
valid cities, zip codes, street types, street directions, unit designators, and street names used in the county.
As a web service, an application developer can utilize the Address Dataset even when they are not on the county
network. Web services are built on SOAP,
so any language that can understand SOAP can be used to access the Address Web Service. AIMS has tested languages
like .NET languages, Java, VB6 and VBA. With the right toolkit, all these languages and more can use the web
service.
Interface
View the service description.
The following methods are available through the Address Web Service:
- ValidateAddressLine
- ValidateAddressWithLocation
- ValidateAddressWithoutLocation
- GeneralSearch
- LookupTaxPropertyID
- LookupTaxUnitDMV
- GetStreetNameDomain
- GetDirectionDomain
- GetStreetTypeDomain
- GetSecUnitDesDomain
- GetCityTownshipDomain
- GetZipCodeDomain
Methods
| Returns |
Description |
| Array of Address |
ValidateAddressLine(string securityKey, string addressLine)
Given an address string, returns all possible matches.
|
| Array of Address |
ValidateAddressWithLocation(string securityKey, string streetNumber, string predirection,
string streetName, string streetType, string secUnitDesignator, string secUnit, string city, string state,
string zipcode)
Given an address in parts, returns all possible matches. Use this method for
more accurate results.
|
| Array of Address |
ValidateAddressWithoutLocation(string securityKey, string streetNumber, string predirection,
string streetName, string streetType, string secUnitDesignator, string secUnit)
Given an address in parts without city, state, or zipcode, returns all possible
matches. Use this method for more accurate results.
|
| Array of Address |
General Search(string securityKey, string streetNumber, string predirection,
string streetName, string streetType, string city, string state, string zipcode)
Searches for an address and returns up to 100 matches. No search is done on
state or zipcode.
|
| string |
LookupTaxPropertyID(string securityKey, string APID)
Lookup the Tax Property ID of an address.
|
| string |
LookupTaxUnitDMV(string securityKey, string APID)
Lookup the Tax Unit used by the DMV of an address.
|
| Array of string |
GetStreetNameDomain(string securityKey)
Get the domain of street names.
|
| Array of string |
GetDirectionDomain(string securityKey)
Get the domain of street directions.
|
| Array of string |
GetStreetTypeDomain(string securityKey)
Get the domain of street types.
|
| Array of string |
GetSecUnitDesDomain(string securityKey)
Get the domain of secondary unit designators.
|
| Array of string |
GetCityTownshipDomain(string securityKey)
Get the domain of city and townships.
|
| Array of string |
GetZipCodeDomain(string securityKey)
Get the domain of ZIP codes.
|
Address Structure
The Address structure returned from some methods mentioned above has the following
form:
| Attribute |
Type |
Description |
| APID |
String |
Unique Address Point ID |
| StreetNumber |
String |
|
| Predirection |
String |
|
| StreetName |
String |
|
| StreetType |
String |
|
| SecUnitDesignator |
String |
Secondary Unit Designator |
| SecUnit |
String |
Secondary Unit |
| City |
String |
|
| State |
String |
|
| Zipcode |
String |
|
| X |
String |
X coordinate for mapping |
| Y |
String |
Y coordinate for mapping |
| AddressLine |
String |
Concatenation of StreetNumber + Predirection + StreetName + StreetType +
SecUnitDesignator + SecUnit
|
| CityLine |
String |
Concatenation of City + State + Zipcode
|
If nothing is found or there was an error then an empty array of addresses will
be returned.
Examples
These examples provided below are not working examples. They are shown here to show
how you can connect to the web service through different languages/programs.
Excel Spreedsheet Example
You can use the Address Web Service in many different environments. In this example,
we'll show that even an Microsoft Office document can take advantage of the web service.
Figure 1. Excel Sample
Figure 1 shows a simple Microsoft Excel that you can enter an address and validate it. If the user
were to type an address in cell B1 and press the "Validate Address" button, VBA code can send
the address to the web service and get a list of matching addresses to the one entered as seen
below.
Figure 2. Excel Sample
.NET and Java can produce the same results. As long as you have a programming language that can communicate to
a web service, you could use the Address Web Service to validate addresses in Johnson County.
Downloads
Excel spreedsheet example
Toolkits
Microsoft Office XP Web Service Toolkit 2.0
Microsoft Office 2003 Web Service Toolkit 2.01
Java Web Services Developer Pack
Contact Information
If you have any questions please contact the
.
|