User-Defined Boundary File - Spectrum_OnDemand - enterprise_tax - web_services - Latest

Spectrum OnDemand Web Services (REST)
Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Spectrum Platform
Spectrum > Dataflow Designer
Spectrum > Quality > Spectrum Quality
Spectrum > Discovery
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Quality > Context Graph
Spectrum > Quality > Addressing
Spectrum OnDemand
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Geo Addressing > Enterprise Tax
Spectrum > Spatial > Spectrum Spatial Analyst
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
Last updated
2024-08-28
Published on
2024-08-28T12:55:51.727818

The following table 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: ReverseGeoTAXInfoLookup can return up to 10 user-defined areas for each input location.
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 Option.DefaultUserBufferWidth or by the input fieldData.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.