Alternative Columns - Stage 2
Deprecation of alternative output column names - STAGE 2
The Batch API currently accepts a wide range of alternative names for output columns.
These alternative names are undocumented and do not adhere to the official schema for output column names (See Reading batch request output). We plan to deprecate their usage.
The following list outlines values that will be deprecated and replaced with a camel-case concatenation of the corresponding property values from the dedicated field.
To ensure clarity, all deprecated properties are presented in lowercase.
Alternative property values
Note
Effective starting TBD - not defined yet.
DEPRECATED Column names
| Deprecated property name | Valid property name |
|---|---|
| label | title |
| name | |
| displaycoordinate | position |
| displaylatitude | positionLat |
| positionlatitude | |
| displaylongitude | positionLng |
| positionlongitude | |
| navigationlatitude | accessLat |
| accesslatitude | |
| latitude | |
| lat | |
| navigationlongitude | accessLng |
| accesslongitude | |
| longitude | |
| locationtype | resultType |
| matchtype | houseNumberType |
| locationlabel | addressLabel |
| address | |
| countrycode | addressCountryCode |
| country | |
| countryname | addressCountryName |
| statecode | addressStateCode |
| statename | addressState |
| state | |
| countycode | addressCountyCode |
| countyname | addressCounty |
| county | |
| city | addressCity |
| district | addressDistrict |
| subdistrictname | addressSubdistrict |
| subdistrict | |
| streetname | addressStreet |
| street | |
| postalcode | addressPostalCode |
| housenumber | addressHouseNumber |
| building | addressBuilding |
| mapReferencesPointAddress | mapReferencesPointAddressHmcid |
| queryscore | scoringQueryScore |
| relevance | |
| matchqualitystreet | scoringFieldScoreStreets |
| streetfieldscore | |
| streetscore | |
| matchqualityhousenumber | scoringFieldScoreHouseNumber |
| housenumberfieldscore | |
| housenumberscore | |
| matchqualitybuilding | scoringFieldScoreBuilding |
| buildingscore | |
| matchqualitysubblock | scoringFieldScoreSubblock |
| placenamefieldscore | scoringFieldScorePlacename |
| matchqualitydistrict | scoringFieldScoreDistrict |
| districtscore | |
| matchqualitycity | scoringFieldScoreCity |
| cityfieldscore | |
| cityscore | |
| matchqualitycounty | scoringFieldScoreCounty |
| countyfieldscore | |
| countyscore | |
| matchqualitystate | scoringFieldScoreState |
| statefieldscore | |
| statescore | |
| matchqualitycountry | scoringFieldScoreCountry |
| countryfieldscore | |
| countryscore | |
| postalcodescore | scoringFieldScorePostalCode |
| matchqualitypostalcode |
Updated this month