SmartMover V3:Response

From Melissa Data Wiki
Jump to navigation Jump to search

← SmartMover V3

SmartMover V3 Navigation
Introduction
Licensing
Transitioning From V2b
Input/Output
Request Fields
Response Fields
Examples
REST JSON
JSON
XML
Result Codes
Result Code Use
SmartMover V3
Sample Code



A response is the result of a request. This consists of returned results codes and COA details.

SmartMover V3 supports the JSON and XML response protocols.


Field Names

This is a list of the response field names and their grouping.

You can choose what output columns to return by entering the column name in the Column input. Specifying a group name will return all columns in the group.

Field Name Group
TransmissionResults [DEFAULT]

Always return in the output structure.

TransmissionReference
Version
TotalRecords
CASSReportLink
NCOAReportLink
Records
AddressExtras
AddressKey
AddressLine1
AddressLine2
AddressTypeCode
BaseMelissaAddressKey
CarrierRoute
City
CityAbbreviation
CompanyName
CountryCode
CountryName
DeliveryIndicator
DeliveryPointCheckDigit
DeliveryPointCode
MelissaAddressKey
MoveEffectiveDate
MoveTypeCode
PostalCode
RecordID
Results
State
StateName
Urbanization
NameFirst grpName
NameFull
NameLast
NameMiddle
NamePrefix
NameSuffix
OriginalAddressLine1 grpOriginal
OriginalAddressLine2
OriginalCity
OriginalCityAbbreviation
OriginalCountryCode
OriginalPlus4
OriginalPostalCode
OriginalPrivateMailbox
OriginalResults
OriginalState
OriginalStateName
OriginalSuite
OriginalUrbanization
AddressDeliveryInstallation grpParsed
AddressHouseNumber
AddressLockBox
AddressPostDirection
AddressPreDirection
AddressPrivateMailboxName
AddressPrivateMailboxRange
AddressRouteService
AddressStreetName
AddressStreetSuffix
AddressSuiteName
AddressSuiteNumber
StandardizedAddressLine1 grpStandardized
StandardizedAddressLine2
StandardizedBaseMelissaAddressKey
StandardizedCarrierRoute
StandardizedCity
StandardizedCityAbbreviation
StandardizedCountryCode
StandardizedDeliveryIndicator
StandardizedDeliveryPointCheckDigit
StandardizedDeliveryPointCode
StandardizedMelissaAddressKey
StandardizedPlus4
StandardizedPostalCode
StandardizedPrivateMailbox
StandardizedResults
StandardizedState
StandardizedStateName
StandardizedSuite
StandardizedUrbanization
DPVFootNotes [COLUMN NAME ONLY]

These columns can only be requested by using their name.

MoveReturnCode
Plus4
PrivateMailbox
Suite


[DEFAULT]

TransmissionResults

Returns the generic web service level result/error codes. For more information, see SmartMover V3 Result Codes.
Protocol Syntax
JSON "TransmissionResults":"string"


TransmissionReference

A pass-through of the input Transmission Reference.
Protocol Syntax
JSON "TransmissionReference":"string"


Version

The current web service version.
Protocol Syntax
JSON "Version":"string"


TotalRecords

The total number of records returned in the records array.
Protocol Syntax
JSON "TotalRecords":"string"


CASSReportLink

CASS summary report link.
Protocol Syntax
JSON "CASSReportLink":"string"


NCOAReportLink

NCOA summary report link.
Protocol Syntax
JSON "NCOAReportLink":"string"


Records

This is the returned array of records.
Protocol Syntax
JSON "Records":"string"


AddressExtras

Returns any text that could not be identified as belonging to any of the other address fields.
Protocol Syntax
JSON "AddressExtras":"string"


AddressKey

Returns a unique key for the current address.
Protocol Syntax
JSON "AddressKey":"string"


AddressLine1

Address Line 1.
Protocol Syntax
JSON "AddressLine1":"string"


AddressLine2

Address Line 2.
Protocol Syntax
JSON "AddressLine2":"string"


AddressTypeCode

Code specifying the type of address. For a list of codes, see SmartMover V3 Result Codes.
Code Type
F Firm or Company
G General Delivery
H Highrise or Business Complex
P PO Box
R Rural Route
S Street or Residential


Protocol Syntax
JSON "AddressTypeCode":"string"


BaseMelissaAddressKey

A unique key assigned to the base address of a complex with apartments or suites.
Protocol Syntax
JSON "BaseMelissaAddressKey":"string"


CarrierRoute

Carrier route code, with the first character being alphabetic and the following three characters being numeric. The alphabetic letter indicates the type of delivery associated with the address. For a list of codes, see SmartMover V3 Result Codes.
Code Description
B PO Box
C City Delivery
G General Delivery
H Highway Contract
R Rural Route


Protocol Syntax
JSON "CarrierRoute":"string"


City

City name. If the city name is more than 28 characters long, CityAbbreviation will contain the official USPS abbreviation for the city.
Protocol Syntax
JSON "City":"string"


CityAbbreviation

City abbreviation. If the city name is more than 28 characters long, this will contain the official USPS abbreviation for the city.
Protocol Syntax
JSON "CityAbbreviation":"string"


CompanyName

Name of the business.
Protocol Syntax
JSON "CompanyName":"string"


CountryCode

The standard code of the country. Currently only Canada and the United States are supported.
Protocol Syntax
JSON "CountryCode":"string"


CountryName

The full country name. Currently only Canada and the United States are supported.
Protocol Syntax
JSON "CountryName":"string"


DeliveryIndicator

The RBDI Indicator code based on the address. For a list of codes, see SmartMover V3 Result Codes.
Code Description
R Residential Address
B Business Address
U Unknown


Protocol Syntax
JSON "DeliveryIndicator":"string"


DeliveryPointCheckDigit

Contains the 12th digit of the POSTNET barcode.
Protocol Syntax
JSON "DeliveryPointCheckDigit":"string"


DeliveryPointCode

Contains the 10th and 11th digits of the POSTNET barcode, usually the last two digits of the street number.
Protocol Syntax
JSON "DeliveryPointCode":"string"


MelissaAddressKey

(MAK) A unique key assigned to an address record.
Protocol Syntax
JSON "MelissaAddressKey":"string"


MoveEffectiveDate

US Only. Returns the effective date of the move in the format "YYYYMM".
Protocol Syntax
JSON "MoveEffectiveDate":"string"


MoveTypeCode

Specifies the type of address record matched. For a list of codes, see SmartMover V3 Result Codes.
Code Description
F Family
B Business
I Individual


Protocol Syntax
JSON "MoveTypeCode":"string"


PostalCode

Postal Code.
Protocol Syntax
JSON "PostalCode":"string"


RecordID

Position of the record in the response array.
Protocol Syntax
JSON "RecordID":"string"


Results

Returns record specific result codes. For a list of codes, see SmartMover V3 Result Codes.
Protocol Syntax
JSON "Results":"string"


State

Standard two-letter abbreviation of the state.
Protocol Syntax
JSON "State":"string"


StateName

Full name of the state.
Protocol Syntax
JSON "StateName":"string"


Urbanization

Returns the value passed to the Urbanization field in the request.
Only used for addresses in Puerto Rico. This is used to break ties between similar addresses in the same Postal Code.
Protocol Syntax
JSON "Urbanization":"string"


GrpName

NameFirst

Returns the first name as submitted to the NameFirst field in the request.
Protocol Syntax
JSON "NameFirst":"string"


NameFull

Returns the full name as submitted to the NameFull field in the request.
Protocol Syntax
JSON "NameFull":"string"


NameLast

Returns the last name as submitted to the NameLast field in the request.
Protocol Syntax
JSON "NameLast":"string"


NameMiddle

Returns the middle name as submitted to the NameMiddle field in the request.
Protocol Syntax
JSON "NameMiddle":"string"


NamePrefix

Returns the name prefix as submitted to the NamePrefix field in the request.
Protocol Syntax
JSON "NamePrefix":"string"


NameSuffix

Returns the name suffix as submitted to the NameSuffix field in the request.
Protocol Syntax
JSON "NameSuffix":"string"


GrpOriginal

OriginalAddressLine1

Returns the original address line 1 exactly as submitted in the request.
Protocol Syntax
JSON "OriginalAddressLine1":"string"


OriginalAddressLine2

Returns the original address line 2 exactly as submitted in the request.
Protocol Syntax
JSON "OriginalAddressLine2":"string"


OriginalCity

Returns the original city exactly as submitted in the request.
Protocol Syntax
JSON "OriginalCity":"string"


OriginalCityAbbreviation

Returns the original country abbreviation exactly as submitted in the request.
Protocol Syntax
JSON "OriginalCityAbbreviation":"string"


OriginalCountryCode

Returns the original country code exactly as submitted in the request.
Protocol Syntax
JSON "OriginalCountryCode":"string"


OriginalPlus4

Returns the original Plus + 4 exactly as submitted in the request.
Protocol Syntax
JSON "OriginalPlus4":"string"


OriginalPostalCode

Returns the original postal code exactly as submitted in the request.
Protocol Syntax
JSON "OriginalPostalCode":"string"


OriginalPrivateMailbox

Returns the original private mailbox exactly as submitted in the request.
Protocol Syntax
JSON "OriginalPrivateMailbox":"string"


OriginalResults

Returns the original results exactly as submitted in the request.
Protocol Syntax
JSON "OriginalResults":"string"


OriginalState

Returns the original state exactly as submitted in the request.
Protocol Syntax
JSON "OriginalState":"string"


OriginalStateName

Returns the original state name exactly as submitted in the request.
Protocol Syntax
JSON "OriginalStateName":"string"


OriginalSuite

Returns the original suite exactly as submitted in the request.
Protocol Syntax
JSON "OriginalSuite":"string"


OriginalUrbanization

Returns the original urbanization exactly as submitted in the request.
Protocol Syntax
JSON "OriginalUrbanization":"string"


GrpParsed

AddressDeliveryInstallation

Canada Only. Returns the parsed delivery installation of the address.
Protocol Syntax
JSON "AddressDeliveryInstallation":"string"


AddressHouseNumber

Returns the parsed numeric portion of the street address.
Protocol Syntax
JSON "AddressHouseNumber":"string"


AddressLockBox

Returns the parsed lockbox.
Protocol Syntax
JSON "AddressLockBox":"string"


AddressPostDirection

Returns the parsed directional abbreviation that comes after the street name. For example, "Park Ave South" would return "S".
Protocol Syntax
JSON "AddressPostDirection":"string"


AddressPreDirection

Returns the parsed directional abbreviation that comes before the street name. For example, "100 North Main Street" would return "N".
Protocol Syntax
JSON "AddressPreDirection":"string"


AddressPrivateMailboxName

Returns the parsed non-numeric portion of a private mailbox number. Either "#" or "PMB".
Protocol Syntax
JSON "AddressPrivateMailboxName":"string"


AddressPrivateMailboxRange

Returns the parsed numeric portion of an address if it is located at a Commercial Mail Receiving Agency (CMRA).
Protocol Syntax
JSON "AddressPrivateMailboxRange":"string"


AddressRouteService

Returns the parsed route service.
Protocol Syntax
JSON "AddressRouteService":"string"


AddressStreetName

Returns the parsed name portion of the street address. This excludes the street number, suffix, and any directionals.
Protocol Syntax
JSON "AddressStreetName":"string"


AddressStreetSuffix

Returns the parsed street suffix. E.g. "Rd", "St", or "Blvd".
Protocol Syntax
JSON "AddressStreetSuffix":"string"


AddressSuiteName

Returns the parsed standardized text from the suite. E.g. "STE" or "Unit".
Protocol Syntax
JSON "AddressSuiteName":"string"


AddressSuiteNumber

Returns the parsed numeric portion of the suite.
Protocol Syntax
JSON "AddressSuiteNumber":"string"


GrpStandardized

StandardizedAddressLine1

Returns the standardized address line 1 using USPS addressing standards.
Protocol Syntax
JSON "StandardizedAddressLine1":"string"


StandardizedAddressLine2

Returns the standardized address line 2 using USPS addressing standards.
Protocol Syntax
JSON "StandardizedAddressLine2":"string"


StandardizedBaseMelissaAddressKey

Returns the Base Melissa Address Key of the standardized address.
Protocol Syntax
JSON "StandardizedBaseMelissaAddressKey":"string"


StandardizedCarrierRoute

Returns the standardized carrier route using USPS addressing standards.
Protocol Syntax
JSON "StandardizedCarrierRoute":"string"


StandardizedCity

Returns the standardized city using USPS addressing standards.
Protocol Syntax
JSON "StandardizedCity":"string"


StandardizedCityAbbreviation

Returns the standardized city abbreviation using USPS addressing standards.
Protocol Syntax
JSON "StandardizedCityAbbreviation":"string"


StandardizedCountryCode

Returns the standardized country code using USPS addressing standards.
Protocol Syntax
JSON "StandardizedCountryCode":"string"


StandardizedDeliveryIndicator

Returns the standardized delivery indicatior using USPS addressing standards.
Protocol Syntax
JSON "StandardizedDeliveryIndicator":"string"


StandardizedDeliveryPointCheckDigit

Returns the standardized delivery point check digit using USPS addressing standards.
Protocol Syntax
JSON "StandardizedDeliveryPointCheckDigit":"string"


StandardizedDeliveryPointCode

Returns the standardized delivery point code using USPS addressing standards.
Protocol Syntax
JSON "StandardizedDeliveryPointCode":"string"


StandardizedMelissaAddressKey

Returns the Melissa Address Key of the standardized address.
Protocol Syntax
JSON "StandardizedMelissaAddressKey":"string"


StandardizedPlus4

Returns the standardized Plus + 4 using USPS addressing standards.
Protocol Syntax
JSON "StandardizedPlus4":"string"


StandardizedPostalCode

Returns the standardized postal code using USPS addressing standards.
Protocol Syntax
JSON "StandardizedPostalCode":"string"


StandardizedPrivateMailbox

Returns the standardized private mailbox using USPS addressing standards.
Protocol Syntax
JSON "StandardizedPrivateMailbox":"string"


StandardizedResults

Returns the results of the standardized address.
Protocol Syntax
JSON "StandardizedResults":"string"


StandardizedState

Returns the standardized state using USPS addressing standards.
Protocol Syntax
JSON "StandardizedState":"string"


StandardizedStateName

Returns the standardized state name using USPS addressing standards.
Protocol Syntax
JSON "StandardizedStateName":"string"


StandardizedSuite

Returns the standardized suite using USPS addressing standards.
Protocol Syntax
JSON "StandardizedSuite":"string"


StandardizedUrbanization

Returns the standardized urbanization using USPS addressing standards.
Protocol Syntax
JSON "StandardizedUrbanization":"string"


[COLUMN NAME ONLY]

These columns can only be requested by using their name.

DPVFootNotes

Indicates the level of matching between the current address and the USPS's DPV database. This footnote may be up to six characters long. For a list of codes, see SmartMover V3 Result Codes.
Protocol Syntax
JSON "DPVFootNotes":"string"


MoveReturnCode

Code indicating the level of matching between the record and the NCOA Link database. For a list of codes, see SmartMover V3 Result Codes.
Protocol Syntax
JSON "MoveReturnCode":"string"


Plus4

The last four digits of the ZIP + 4.
Protocol Syntax
JSON "Plus4":"string"


PrivateMailbox

If the address is a private mailbox serivce the number will be returned here.
Protocol Syntax
JSON "PrivateMailbox":"string"


Suite

Address suite.
Protocol Syntax
JSON "Suite":"string"