Geocoding Multiple Addresses with one Request
With the geocodeAddresses operation you can geocode multiple addresses with one request. For example, this can be useful for geocoding addresses that are stored in an address database.
The following listing shows the general structure of the operation in the WSDL file of the Map24 Geocoder 5.1 Service:
...
<message name="geocodeAddressesRequest" >
<part name="RequestHeader" type="tns:RequestHeader" />
<part name="GeocodeAddressesRequest" type="tns:GeocodeAddressesRequest" />
</message>
<message name="geocodeAddressesResponse" >
<part name="GeocodeAddressesResponse" type="tns:GeocodeAddressesResponse" />
</message>
...
<portType name="Map24Geocoder51PortType" >
<operation name="geocodeAddresses" >
<input message="tns:geocodeAddressesRequest" />
<output message="tns:geocodeAddressesResponse" />
</operation>
...
</portType>
...
Request
The GeocodeAddressesRequest element contains the parameters for the geocodeAddresses operation.
| Field |
Description |
| MaxNoOfAlternatives |
The maximum number of results (Alternative elements) to be retrieved for one given address. |
| Addresses |
An array of Address elements.
|
Response
GeocodeAddressesResponse contains the result of the geocodeAddresses operation in the GeocodedAddresses array.
The GeocodedAddresses array contains a GeocodedAddress element for each address that was specified in the request.
A GeocodedAddress element contains the following information:
- If an ID is passed for the input address in the request, the ID field contains this ID. Otherwise, this field is empty.
- The HouseNo, Street, ZIP, etc. fields contain the input address data. Only those fields are returned that have been provided in the request.
- The Alternatives array contains the geocoding results. If more than one address was found for the given address data, multiple geocoding results are provided in the Alternatives array. Note that the maximum number of returned geocoding results can be defined in the request with MaxNoOfAlternatives. A geocoding result is contained in a GeocodeAddress.Alternative element. The structure of a GeocodeAddress.Alternative element is shown in the following figure:
Fields of a GeocodeAddress.Alternative element:
| Field |
Description
|
ID
|
A unique identifier of the request. If an ID is passed in the request, it is returned in the response. Otherwise, this field is empty.
|
| HouseNo |
The house number of the geocoding result (if available). |
| Street |
The street of the geocoding result. |
ZIP
|
The ZIP code of the geocoding result. |
City
|
The city of the geocoding result. |
District
|
The district.
|
County
|
The county.
|
State
|
The state.
|
Country
|
The country of the geocoding result.
|
Quality
|
The quality of the result. The following quality levels are defined:
- Exact: The result matches the input address exactly. Even the house numbers of the input address and the result are identical.
- Street: The result matches the input address on street level.
- ZIP: The result matches the input address on ZIP code level.
- District: The result matches the input address on city district level.
- City: The result matches the input address on city level.
- Mismatch: The result does not match the input address.
|
Similarity
|
The similarity between the result and the given input address in a scale from "0.00" (mismatch) to "1.00" (direct hit). Besides the Quality element, this field provides information on the accuracy of the result. |
Coordinate
|
The latitude and longitude of the result. |
Examples
An example request is provided here.
|
