Table Of ContentSpectrum™ Technology Platform
Version 11.0
API Guide
Table of Contents
Message 128
DataTable 135
1 - Getting Started
DataRow 141
Map 148
GeneralStepsforUsingtheAPI 5
HowDataisPassedtoaService 6
5 - The Java API
SupportedCompilers 8
Third-PartyLibraries 12
NetworkProtocolsandPorts 12 Introduction 153
UsingtheSampleApplications 12 Server 157
UsingSSL 13 Service 163
IncreasingtheTimeoutValue 14 Message 164
DataTable 170
DataRow 175
2 - The C API
6 - ManagementAPI Methods
IntroductiontotheCAPI 16
Server 31
Service 36 Introduction 183
Message 37 GetLicenseInfo 183
DataTable 50 GetVersionInfo 184
DataRow 58
7 - The .NET API
3 - The C++ API
Introduction 186
IntroductiontotheC++API 73 Server 190
Server 86 Service 192
Service 90 Message 193
Message 91 EnhancedDataTable 200
DataTable 101
DataRow 108
8 - Module Services
4 - The COM API
AddressNowModule 204
EnterpriseGeocodingModule 253
Introduction 120 EnterpriseTaxModule 455
Server 124 GeoConfidenceModule 581
Service 127 UniversalAddressingModule 584
UniversalNameModule 755
9 - About Spectrum™
Technology Platform
WhatIsSpectrum™TechnologyPlatform? 767
EnterpriseDataManagementArchitecture 768
Spectrum™TechnologyPlatformArchitecture 772
ModulesandComponents 775
Appendix
Appendix A:
Country ISO Codes and Module Support 780
Spectrum™TechnologyPlatform11.0 APIGuide 3
1 - Getting Started
In this section
General Steps for Using the API 5
How Data is Passed to a Service 6
Supported Compilers 8
Third-Party Libraries 12
Network Protocols and Ports 12
Using the Sample Applications 12
Using SSL 13
Increasing the Timeout Value 14
GettingStarted
General Steps for Using the API
The basic steps for using the Spectrum™ Technology Platform API are:
1. Create a Server instance.
2. Set connection properties (connection type, host, port, etc.).
3. Connect to the Server.
4. Create a DataTable.
5. Add records to the DataTable.
6. Create a request message.
7. Set DataTable on the request message.
8. Get a service.
9. Send the request message to the Server.
10.Process the response message.
11.Disconnect from the Server.
Spectrum™TechnologyPlatform11.0 APIGuide 5
GettingStarted
How Data is Passed to a Service
The following diagram illustrates how data is passed to a service through the API:
Spectrum™TechnologyPlatform11.0 APIGuide 6
GettingStarted
Message
UsetheMessagecomponenttosendyourinputdatatotheSpectrum™TechnologyPlatformservice
and receive output data from the service.
You can also use the Message component to override a service's default processing options. The
default options for a service are set in Management Console. For example, the service
ValidateAddress is capable of producing output in either mixed case or upper case. Let's say that
in most instances, you need upper case output. However, one of your applications requires output
in mixed case. In this situation, you would set the default for casing in the ValidateAddress service
to upper case and override the default casing setting for that single application using the API. For
thoserequeststhatshouldbehandledaccordingtothedefaultsyouhavespecified,itisnotnecessary
to provide any input options in your request.
The properties for Message include context properties, such as account ID, account password,
servicename,andservicemethod;optionproperties,whicharetheservice-specificruntimeoptions;
and error properties, which are the error class, error message, and error stacktrace.
Spectrum™TechnologyPlatform11.0 APIGuide 7
GettingStarted
DataTable
The DataTable component contains the records for your input and output data. Using the methods
associatedwiththisclass,youdefinethecolumnnamesforyouroutputandaddrecordstothedata
set.TheResetandNextmethodsareusedtoiterateovertheresultsthatarereturnedinaresponse
from the server.
DataRow
TheDataRowcontainsschemainformationandalistofdatarows.Individualrecordsresideinrows
of data. For each output data row there are record-level qualifiers, field-level data, and field-level
qualifiers.
Record-levelqualifiersdescribetheprocessingoftherecord.Record-levelqualifiersincludestatus
of the request (Success, Failure, or Error) and confidence in the accuracy of the output record.
Field-level data contains the validated, standardized, or enhanced record.
Field-level qualifiers include additional data about a given field. For example, the type of a Private
Mailbox according to USPS categorization is a field-level qualifier.
Server
The Server component represents the Spectrum™ Technology Platform server. Using a Server
component, you connect, disconnect, or access a specific service from the server.
Service
TheServicecomponentisusedtoprocessthemessageyou'resending(i.e.,sendtheinputmessage
and get back the response). The Service component has just one method: Process message.
Supported Compilers
The Spectrum™ Technology Platform Client SDK is supported with the following compiler and
runtime minimum versions.
Java
Client SDK Package Directory: clientSDK/platforms/java
Client SDK requires the Java JDK, version 1.4 or higher. This is not installed with the Client SDK.
Windows 32-bit
• JDK: 1.4
• C Compiler: MSVC 6.0 SP3, MSVC 2003, MSVC 2005, MSVC 2008
• C++ Compiler: MSVC 6.0 SP3, MSVC 2003, MSVC 2005, MSVC 2008
Spectrum™TechnologyPlatform11.0 APIGuide 8
GettingStarted
• C# .NET: Microsoft .NET Framework 1.1
• Visual Basic: MS Visual Basic 6.0
Windows 64-bit
• JDK: 1.4
• C Compiler: MSVC 2005, MSVC 2008
• C++ Compiler: MSVC 2005, MSVC 2008
HP-UX RISC
• JDK: 1.4
• C Compiler: cc: HP92453-01 A.11.01.21 HP C (Bundled) Compiler
• C++ Compiler: aCC: HP aC++ B3910B A.03.30 HP aC++ B3910B A.03.27
The clientSDK 32-bit lib is linked to the following libraries:
• libpthread.1
• librt.2
• libnsl.1
• libxti.2
The clientSDK 64-bit lib is linked to the following libraries:
• libpthread.1
• libnsl.1
• librt.2
• libdl.1
• libc.2
• libxti.2
• libdl.1
HP-UX Itanium
• JDK: 1.4
• C Compiler: cc: HP aC++/ANSIC B3910B A.06.05
• C++ Compiler: aCC: HP aC++/ANSIC B3910B A.06.05
The clientSDK 32-bit lib is linked to the following libraries:
• libpthread.so.1
• libnsl.so.1
• librt.so.1
• libxti.so.1
• libdl.so.1
The clientSDK 64-bit lib is linked to the following libraries:
• libpthread.so.1
Spectrum™TechnologyPlatform11.0 APIGuide 9
GettingStarted
• libnsl.so.1
• librt.so.1
• libxti.so.1
• libdl.so.1
Red Hat (32-bit)
• Operating System: Red Hat Linux 2.4.9-e.65smp
• C Compiler: gcc version 2.96 (gcc 4.1 required for the Address Now Module)
• C++ Compiler: g++ version 2.96
The clientSDK lib is linked to the following libraries:
• libstdc++-libc6.2-2.so.3
• libm.so.6
• libc.so.6
• ld-linux.so.2
Red Hat (64-bit)
• Operating System: Red Hat Linux version 2.6.9-34.0.2.ELsmp
• C Compiler: gcc version 3.4.5
• C++ Compiler: g++ version 3.4.5
The clientSDK lib is linked to the following libraries:
• libstdc++.so.6
• libm.so.6
• libgcc_s.so.1
• libpthread.so.0
• libc.so.6
• ld-linux-x86-64.so.2
SuSE
• Operating System: SuSE SLES 8 (powered by UnitedLinux 1.0) (i586)\nKernel 2.4.21-295-smp
(0).
• C Compiler: gcc version 3.2.2
• C++ Compiler: g++ version 3.2.2
The clientSDK lib (32-bit) is linked to the following libraries:
• libstdc++.so.5
• libm.so.6
• libgcc_s.so.1
• libc.so.6
• ld-linux.so.2
Spectrum™TechnologyPlatform11.0 APIGuide 10
Description:Visual Basic: MS Visual Basic 6.0. Windows 64-bit. • JDK: 1.4. • C Compiler: MSVC 2005, MSVC 2008. • C++ Compiler: MSVC 2005, MSVC 2008.
