API Guide

Content
Search Results
Loading, please wait ...

Loading

  • Welcome
  • Getting Started
    • General Steps for Using the API
    • How Data is Passed to a Service
    • Micro-batch Processing
    • Supported Compilers
    • Third-Party Libraries
    • Network Protocols and Ports
    • Using the Sample Applications
    • Using HTTPS
    • Increasing the Timeout Value
  • The C API
    • Introduction to the C API
      • Supported Libraries
        • C Libraries Supported on Windows
      • Constants
      • Error Messages
      • Example Application
    • Server
      • CreateServer
      • DeleteServer
      • SetConnectionProperty
      • ServerConnect
      • ServerDisconnect
      • GetServiceFromServer
    • Service
      • ProcessMessage
    • Message
      • CreateMessage
      • DeleteMessage
      • GetContext
      • GetContextMap
      • PutContext
      • PutContextMap
      • SetContextMap
      • GetOption
      • GetOptions
      • PutOption
      • PutOptions
      • SetOptions
      • GetError
      • GetDataTable
    • DataTable
      • CreateDataTable
      • DeleteDataTable
      • AddColumn
      • GetColumnNames
      • GetColumnIndex
      • GetColumnCount
      • Clear
      • GetDataRows
      • AddRow
      • NewRow
      • GetRowCount
      • MergeDataTable
    • DataRow
      • CreateDataRow
      • DeleteDataRow
      • GetColumnNamesFromRow
      • GetColumnIndexFromRow
      • GetColumnCountFromRow
      • GetByIndex
      • GetByName
      • MergeDataRow
      • SetByName
      • SetByIndex
      • AddChild
      • GetChildren
      • ListChildNames
      • SetChildren
  • The C++ API
    • Introduction to the C++ API
      • Supported Libraries
      • Constants
      • Error Messages
      • SmartPointer
      • Example Application
    • Server
      • Constructors
      • Destructor
      • Connect
      • Disconnect
      • SetConnectionProperty
      • GetService
    • Service
      • Process
    • Message
      • Constructors
      • Destructor
      • GetContext
      • GetContext
      • PutContext
      • PutContext
      • SetContext
      • GetOption
      • GetOptions
      • PutOption
      • PutOptions
      • SetOptions
      • GetError
      • GetDataTable
    • DataTable
      • Constructors
      • Destructor
      • AddColumn
      • GetColumnNames
      • GetColumnIndex
      • GetColumnCount
      • Clear
      • Iterator
      • AddRow
      • NewRow
      • GetRowCount
      • Merge
    • DataRow
      • Constructor
      • Destructor
      • GetColumnNames
      • GetColumnIndex
      • GetColumnCount
      • Get
      • Get
      • Merge
      • Set
      • Set
      • AddChild
      • GetChildren
      • ListChildNames
      • SetChildren
  • The Java API
    • Introduction
      • Constants
      • Error Messages
      • Example Application
    • Server
      • Connect
      • Disconnect
      • SetConnectionProperty
      • GetService
    • Service
      • Process
    • Message
      • GetContext
      • GetContext
      • PutContext
      • PutContext
      • SetContext
      • GetOption
      • GetOptions
      • PutOption
      • PutOptions
      • SetOptions
      • GetError
      • GetDataTable
    • DataTable
      • AddColumn
      • GetColumnNames
      • GetColumnIndex
      • GetColumnCount
      • Clear
      • Iterator
      • AddRow
      • NewRow
      • GetRowCount
      • Merge
    • DataRow
      • GetColumnNames
      • GetColumnIndex
      • Get
      • Get
      • Merge
      • Set
      • AddChild
      • GetChildren
      • ListChildNames
      • SetChildren
      • Set
  • ManagementAPI Methods (Deprecated)
    • Introduction
    • GetLicenseInfo
    • GetVersionInfo
  • Module Services
    • Enterprise Geocoding
      • Enterprise Geocoding
        • Enterprise Geocoding Databases
        • Geocoding Concepts
          • Point Level Matching
          • Street Matching
          • Centroid Matching
        • Geocoding Match Strategies for Non-U.S. Locations
          • Maximizing the Match Rate
          • Maximizing Precision
          • Balancing Match Rate and Precision
        • Postal Concepts
          • Dual Addresses
          • Locatable Address Conversion System (LACS)
          • Delivery Point Validation (DPV)
          • Early Warning System (EWS)
      • Geocode Address Global
      • GeocodeAddressWorld
        • Adding an Enterprise Geocoding Database Resource for World Geocoder
        • Geocode Precision
          • Postal Geocoding
          • Geographic Geocoding
          • Geographic Areas
        • Geocoding Scenarios
        • Input
          • Input Fields
            • Address Aliases
            • Language Aliases
            • State or Province Abbreviations
            • Administrative Divisions and Postal Codes
          • Input Recommendations
          • Single Line Input
        • Options
          • Geocoding Options
          • Matching Options
          • Data Options
        • Output
          • Address Output
          • Geocode Output
          • Result Codes
            • Geographic Candidate Ranking
            • Match Codes
      • GeocodeUSAddress
        • GeocodeUSAddress
        • Input
          • How GeocodeUSAddress Processes Addresses
          • City-only Lastline Matching
          • Address Range Matching
          • Predictive Lastline
        • Options
          • Geocoding Options
          • Matching Options
            • Building, Firm name and Point of Interest matching
            • Predictive Lastline
            • Search Area
            • Multi-matches/Candidates
            • Match Modes
            • Match Code
            • Custom Match Criteria
          • Output Format
          • Output Data
        • Output
          • Auxiliary
          • Block Address
          • Census
          • Centerline
          • Default Output
          • DPV
          • Geoconfidence
          • Latitude/Longitude
          • Parsed Elements
          • Postal Data
          • Qualifiers
          • Range
          • Segment
      • GNAFPIDLocationSearch
        • G-NAF PID Input
        • G-NAF PID Location Search Options
          • G-NAF Geocoding Options
          • G-NAF PID Data Options
        • Output
          • Address Output
          • Geocode Output
          • Result Codes
          • G-NAF Output
      • ReverseAPNLookup
        • ReverseAPNLookup
        • Input
        • Options
        • Output
          • Census
          • Default Output
          • Latitude/Longitude
          • Parsed Elements
          • Postal Data
          • Qualifiers
          • Range
          • Segment
      • Reverse Geocode Address Global
      • ReverseGeocodeUSLocation
        • ReverseGeocodeUSLocation
        • Input
        • Options
          • Configuration Options
          • Output Format
          • Output Data
        • Output
          • Census
          • Default Output
          • Latitude/Longitude
          • Parsed Elements
          • Postal Data
          • Qualifiers
          • Range
          • Segment
      • Geocode US Address Auxiliary Files
        • Auxiliary File Overview
        • Matching to Auxiliary Files
          • Record Type Matching Rules
          • Unavailable Features and Functions
        • Auxiliary Match Output
        • Auxiliary File Layout
      • Match and Location Codes for U.S. Geocoding
        • Match Codes
          • Match Codes
        • Location Codes
          • Address Location Codes
          • Street Centroid Location Codes
          • ZIP + 4 Centroid Location Codes
          • Geographic Centroid Location Codes
      • Result Codes for International Geocoding
        • International Street Geocoding Result Codes (S Codes)
          • Interpreting S Result Codes
        • International Postal Geocoding Result Codes (Z Codes)
        • International Geographic Geocoding Result Codes (G Codes)
        • Reverse Geocoding Codes (R Codes)
        • Non-match Codes
      • Encountering False Positives
        • What is a False-Positive?
        • Reporting DPV False-Positive Violations
          • DPV False Positive Header File Layout
        • Reporting LACS/Link False-Positive Violations
    • Enterprise Tax Module
      • Spectrum Enterprise Tax
        • Spectrum Enterprise Tax Databases
          • Adding a Spectrum Enterprise Tax Database Resource
          • Database Search Order
      • AssignGeoTAXInfo
        • Determining Tax Rates with AssignGeoTAXInfo
        • Address Matching
          • Point-level matching
        • Buffering
        • Input
        • Matching Options
        • Geocoding Options
        • Output Data Options
          • Output Format
        • Output
          • Address Match Results
          • Auxiliary File
          • Census
          • Latitude/Longitude
          • Input Address
          • Parsed Elements
          • Payroll System Tax Code
          • Tax Jurisdiction
          • User-Defined Boundary File
          • Insurance Premium Tax Districts
          • Payroll Tax Districts
          • Special Purpose Tax Districts
          • Sales and Use Tax Rates
          • Error Reporting
      • CalculateDistance
        • Input
        • Options
        • Output
      • ReverseGeoTAXInfoLookup
        • Geocoding Options
        • Output Data Options
          • Output Format
        • Output
          • Auxiliary File
          • Census
          • Input Latitude/Longitude
          • Payroll System Tax Code
          • Tax Jurisdiction
          • User-Defined Boundary File
          • Insurance Premium Tax Districts
          • Payroll Tax Districts
          • Special Purpose Tax Districts
          • Sales and Use Tax Rates
          • Error Reporting
      • Summary Reports
        • Assign GeoTAX Info Summary Report
        • Generating a Summary Report
      • Match and Location Codes
        • Match Codes
        • Location Codes
          • Location Codes
          • Street centroid location codes
          • ZIP + 4 Location Codes
          • Geographic Centroid Location Codes
      • Payroll Tax Correspondence File
        • Using a Payroll Tax Correspondence File
      • User-Defined Data Files
        • Creating a Landmark Auxiliary File
        • Creating a User-Defined Auxiliary File
        • Creating a User-Defined Boundary File
      • Type Codes
      • Class Codes
    • GeoConfidence Module
      • GeoConfidence
        • GeoConfidence Databases
      • GeoConfidenceSurface
        • Input
        • Output
        • Customizing the GeoConfidence Module
    • Global Addressing Module
      • Spectrum Global Addressing Management
        • Spectrum Global Address Validation
          • Supported Countries
          • Options
            • Global Addressing Options
              • Matching Options
              • Custom Match Options
            • US Addressing Options
              • Additional Processing
              • CASS Mailer Information
              • Multiple Address Line Options
              • Log Level Options
          • Input
          • Output
        • Spectrum Global Type Ahead
          • Supported Countries
          • Options
          • Input
          • Output
    • Universal Addressing Module
      • Spectrum Universal Address
        • Addressing Databases
      • AutoCompleteLoqate
        • Input
        • Options
        • Output
      • GetCandidateAddresses
        • Input
        • Options
        • Output
      • GetCandidateAddressesLoqate
        • Input
        • Options
        • Output
      • GetCityStateProvince
        • Input
        • Options
        • Output
      • GetCityStateProvinceLoqate
        • Input
        • Options
        • Output
      • GetPostalCodes
        • Input
        • Options
        • Output
      • GetPostalCodes Loqate
        • Input
        • Options
        • Output
      • ValidateAddress
        • Input
          • Address Line Processing for U.S. Addresses
        • Options
          • Output Data Options
            • Obtaining Congressional Districts
            • Obtaining County Names
            • Obtaining FIPS County Numbers
            • Obtaining Carrier Route Codes
            • Creating Delivery Point Barcodes
          • Default Options
            • About Dual Address Logic
            • Returning Multiple Matches
          • U.S. Address Options
            • CASS Certified Processing
          • Canadian Address Options
            • SERP Processing
            • Obtaining SERP Return Codes
          • International Address Options
        • Output
          • Standard Address Output
          • Parsed Address Elements Output
          • Parsed Input
          • Postal Data Output
          • Result Indicators
            • Record-Level Result Indicators
            • Field-Level Result Indicators
          • Output from Options
          • Additional Input Data
            • Care of Data
            • Extraneous Data on Its Own Address Line
            • Extraneous Data Within an Address Line
            • Dual Addresses
      • ValidateAddressGlobal
        • Input
          • Address Guidelines for Japan
        • Options
          • Input Options
          • Output Options
          • Process Options
        • Output
          • Address Data
          • Original Input Data
          • Result Codes
      • ValidateAddressLoqate
        • Input
        • Options
          • Returning Multiple Matches
          • Match Score Threshold Options
        • Output
          • Standard Address Output
          • Parsed Address Elements Output
          • Parsed Input
          • Geocode Output
          • Result Indicators
            • Record-Level Result Indicators
            • Field-Level Result Indicators
          • The AVC Code
          • AMAS Output
      • Encountering False Positives
        • What is a False-Positive?
        • Reporting DPV False-Positive Violations
          • DPV False Positive Header File Layout
        • Reporting LACS/Link False-Positive Violations
      • ValidateAddress Confidence Algorithm
        • Introduction to the Validate Address Confidence Algorithm
        • Confidence Algorithm for U.S. and Canadian Addresses
        • Confidence Algorithm for International Addresses
    • Spectrum Universal Name
      • OpenNameParser
        • Input
        • Options
          • Parsing Options
          • Cultures Options
          • Advanced Options
          • Configuring Options at Runtime
        • Output
  • About Spectrum Technology Platform
    • What Is Spectrum Technology Platform?
    • Enterprise Data Management Architecture
    • Spectrum Technology Platform Architecture
    • Modules and Components
  • Appendix
    • ISO Country Codes and Module Support
      • ISO Country Codes and Module Support