User-Defined Boundary File

The table below lists the output fields that contain data returned from user-defined boundary files. To include this data in the output, set Option.GeoTAXOutputRecordType = U.

Note: AssignGeoTAXInfo can return up to 10 user-defined areas for each input address.

Response Element

Max. Field Length with null terminator

Description

NumberUserBoundariesFound

3

The number of user-defined polygons found for the address.

UserBoundaryn.BoundaryDescription

51 per User Boundary

A description of the polygon.

UserBoundaryn.BoundaryID

11 per User Boundary

The ID of the polygon as specified in the user-defined boundary file.

UserBoundaryn.BufferRelation

2 per User Boundary

Indicates where in the polygon the address resides in relation to the edge of the area. Buffer width is specified by the option Option.DefaultUserBufferWidth or by the input field Data.BufferWidth.

One of the following:

P
The address is inside the polygon at a distance from the edge that is greater than the specified buffer width.
I
The address is inside the polygon but is close to the edge.
B
The address is outside the polygon but is close to the edge.

For more information, see Buffering.

UserBoundaryn.DistanceToBorder

10 per User Boundary

Indicates the distance from the address to the border of the polygon. The distance is in the units specified by the option Option.DistanceUnits.

UserBoundaryn.SupplementalBoundaryID

11 per User Boundary

A supplemental ID as specified in the user-defined boundary file.

UserBoundaryn.BoundaryConfidence

4 per User Boundary

Provides the percentage overlap of the geocode to the User-defined boundary polygon layer. The returned percentage value describes the probability that the point falls in the User-defined boundary area.