User-Defined Boundary File - enterprise_tax - web_services - 23.1

Spectrum Web Services Guide
Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413

The table below lists the output fields that contain data returned from user-defined boundary files. To include this data in the output, set GeoTAXOutputRecordType Option.GeoTAXOutputRecordType = U. To include this data in the output, click the Output tab, then under Include data, select the User-defined Boundary check box.

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

columnName

Field Name

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 DefaultUserBufferWidth Option.DefaultUserBufferWidth User-defined boundary or by the input field BufferWidth 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 DistanceUnitsOption.DistanceUnits Distance Units .

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.