User-Defined Boundary File - Spectrum_OnDemand - 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 following table 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: Reverse GeoTAX Info Lookup can return up to 10 user-defined areas for each input location.
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 location 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 geocode is inside the polygon at a distance from the edge that is greater than the specified buffer width.
I
The geocode is inside the polygon but is close to the edge. This indicates that the address is in the buffer area.
B
The geocode is outside the polygon but is close to the edge. This indicates that the address is in the buffer area.

For more information, see Buffering.

UserBoundaryn.DistanceToBorder

10 per User Boundary

Indicates the distance in feet from the input location to the border of the polygon.

UserBoundaryn.SupplementalBoundaryID

11 per User Boundary

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