Skip to content

clsCleanAddressInfo

clsCleanAddressInfo is the DTO returned by clsCleanAddress.CleanAddress(). It carries the normalized address fields, vendor return data, and derived classification flags produced during address cleansing.

Purpose

  • Hold the full result of the address-cleansing workflow in a single return object.

Context

  • Namespace: SAIF.Services.CleanAddress
  • Assembly/package: SAIF.Services.CleanAddress

Public members

Member Signature Purpose
Line1 Public Property Line1 As String Returns the primary address line after service processing.
Line2 Public Property Line2 As String Returns the secondary address line after service processing.
City Public Property City As String Returns the city value supplied by the vendor result.
State Public Property State As String Returns the state value supplied by the vendor result.
Zip Public Property Zip As String Returns the five-digit ZIP portion of the vendor result.
Zip4 Public Property Zip4 As String Returns the ZIP+4 add-on portion of the vendor result.
County Public Property County As String Returns the county name supplied by the vendor result.
CountyCode Public Property CountyCode As String Returns the county code supplied by the vendor result.
USPSReturnCode Public Property USPSReturnCode As Integer Returns the numeric USPS status code used for downstream classification.
USPSErrorCodes Public Property USPSErrorCodes As List(Of String) Returns the parsed two-character USPS error codes.
USPSErrorCodeDescriptions Public Property USPSErrorCodeDescriptions As List(Of String) Returns the human-readable description for each parsed USPS error code.
PostnetBarcode Public Property PostnetBarcode As String Returns the derived POSTNET barcode string when barcode construction succeeds.
CleanedAddress Public Property CleanedAddress As Boolean Indicates whether the result satisfies the cleaned-address rule.
MultipleMatches Public Property MultipleMatches As Boolean Indicates whether the result was classified as a multiple-match outcome.
Unmatched Public Property Unmatched As Boolean Indicates whether the result was classified as an unmatched outcome.

Behavioral notes

  • CleanedAddress is set according to BR-001.
  • Unmatched and MultipleMatches are assigned according to BR-002.
  • PostnetBarcode is populated according to BR-005.
  • USPSErrorCodes and USPSErrorCodeDescriptions are populated in matching order while clsCleanAddress.CleanAddress() parses the vendor error-code string.

Constraints and usage notes

  • The object is a passive data container; all population logic resides in clsCleanAddress.CleanAddress().
  • A cleaned result leaves both Unmatched and MultipleMatches set to False.

Sources

  • Services\SAIF.Services.CleanAddress\clsCleanAddressInfo.vb
  • Services\SAIF.Services.CleanAddress\clsCleanAddress.vb