Hopewiser SOAP Interface - Additional Data
Summary
Any call returning address data provides an optional input which allows the user to request more information than would otherwise be returned.
The default data and optional parameter are described for each function that provides this functionality
Data
| Data item | Description | |
| COUNTRY | 0 | String field containing the country |
| COUNTY | 0 | String field containing the county |
| DEDUP_KEY | 0 | String field containing a key for deduplication purposes |
| DISTRICT_1 | 0 | String field containing the minor district of an address |
| DISTRICT_2 | 0 | String field containing the major district of an address |
| DISTRICT_LEVEL | 0 | An array containing formatted sub-premise, premise, street and district level information |
| DPS | 0 | String field containing a 3-character DPS and checksum for the address or 8-character DPID in Australia |
| FORMATTED_FLAT | 0 | String field containing the flat, formatted as if in a label |
| FORMATTED_FLOOR | 0 | String field containing the floor, formatted as if in a label |
| FORMATTED_PREMISE_NO | 0 | String field containing the premise number, formatted as if in a label |
| POSTCODE | 0 | String field containing the postcode |
| STREET_1 | 0 | String field containing the first street of the address |
| STREET_2 | 0 | String field containing the second street of the address |
| ST_NAME | 0 | (Australia only) - String field containing the street name without type |
| ST_TYPE | 0 | (Australia only) - String field containing the street type |
| TOWN | 0 | String field containing the town |
| PZON_X | 1 | String field containing the X-part of the PostZon grid reference. Assitional cost of 1 click when either or both PZON_X and PZON_Y are returned |
| PZON_Y | 1 | String field containing the X-part of the PostZon grid reference. Additional cost of 1 click when either or both PZON_X and PZON_Y are returned |