Hong Kong (HK) Postal Matcher Attributes

This table lists the Hong Kong Postal Matcher attributes.

Note: If you are using the new HK Global Address Verification (GAV) tables delivered in June 2013, the following output attributes are no longer generated: hk_gout_delivery_office, hk_gout_beat_number, hk_gout_matched_bldg_on_street, and hk_gout_postal_code_changed. Instead, the hk_gout_city_name attribute will be used to write the postal district name output.

Attribute

Length

Description

hk_gin_area_name

30

Stores the area name.

hk_gin_building

30

Stores the building name.

hk_gin_city_name

30

Stores the name of the postal city.

hk_gin_filler_01

4

Reserved for future use.

hk_gin_filler_02

6

Reserved for future use.

hk_gin_house_number

8

Stores the house number that typically precedes the street name.
hk_gin_house_number2 3 Stores the overflow house number. For example, if the house number is 12345-12347, then hk_gin_house_number and hk_gin_house_number2 will contain 12345-12 and 347, respectively.

hk_gin_organization_name

30

Contains the organization name.

hk_gin_record_type

1

Contains the built record type.

hk_gin_street_name

30

Contains the street name.

hk_gin_sub_building

25

Contains the unit type within a building, such as Apt.
hk_gin_delivery_office 3

Contains the delivery office code.

Note: This attribute is not generated if you are using the Hong Kong GAV tables for June 2013 or later.

hk_gout_area_name

30

Stores the area name.

hk_gout_beat_number

5

Stores the delivery beat code.

Note: This attribute is not generated if you are using the Hong Kong GAV tables for June 2013 or later.

hk_gout_building

30

Stores the building name.

hk_gout_building_street

30

Contains the street name of building.

hk_gout_city_name

30

Contains the district name.

hk_gout_city_state_changed

1

If Y, indicates the city state name output is different from the input.

hk_gout_completion_code

1

Return code.

0 = Incomplete Address. Not matched to postal file. Check the Match Level Code for more information.

1 = Matched Address.

hk_gout_delivery_address1

50

Contains output delivery address 1. It is formatted as "dwelling building/complex name. "

hk_gout_delivery_address2

50

Contains output delivery address 2.

hk_gout_delivery_office

3

Contains the delivery office code.

hk_gout_house_number

11

Contains the house number.

hk_gout_match_level

1

Contains the numeric code to identify the level at which the address matched, or failed to match, the Global Address Verification (GAV) tables. See Match Level Codes for details.

hk_gout_matched_bldg_on_street

1

Stores the matched street, including the building.

Note: This attribute is not generated if you are using the Hong Kong GAV tables for June 2013 or later.

hk_gout_number_of_changes

1

Stores the number of changes.

hk_gout_postal_code_changed

1

If Y, indicates the postal code is different from the input.

Note: This attribute is not generated if you are using the Hong Kong GAV tables for June 2013 or later.

hk_gout_record_type

1

Contains the record type.

hk_gout_street_name

30

Contains the street name.

hk_gout_street_name_changed

1

If Y, indicates the street name output is different from the input.

hk_gout_street_components_changed

1

If Y, indicates the street components output is different from the input.

hk_gout_sub_building

15

Contains the unit type within a building, such as Apt.

hk_gout_sub_building_of

5

Contains the building in which the sub-building exists.

hk_gout_sub_building_value

10

Unit value within a building, such as Apt# or Unit#.