Struct google_api_proto::google::maps::addressvalidation::v1::UspsData

pub struct UspsData {

    pub standardized_address: Option<UspsAddress>,
    pub delivery_point_code: String,
    pub delivery_point_check_digit: String,
    pub dpv_confirmation: String,
    pub dpv_footnote: String,
    pub dpv_cmra: String,
    pub dpv_vacant: String,
    pub dpv_no_stat: String,
    pub dpv_no_stat_reason_code: i32,
    pub dpv_drop: String,
    pub dpv_throwback: String,
    pub dpv_non_delivery_days: String,
    pub dpv_non_delivery_days_values: i32,
    pub dpv_no_secure_location: String,
    pub dpv_pbsa: String,
    pub dpv_door_not_accessible: String,
    pub dpv_enhanced_delivery_code: String,
    pub carrier_route: String,
    pub carrier_route_indicator: String,
    pub ews_no_match: bool,
    pub post_office_city: String,
    pub post_office_state: String,
    pub abbreviated_city: String,
    pub fips_county_code: String,
    pub county: String,
    pub elot_number: String,
    pub elot_flag: String,
    pub lacs_link_return_code: String,
    pub lacs_link_indicator: String,
    pub po_box_only_postal_code: bool,
    pub suitelink_footnote: String,
    pub pmb_designator: String,
    pub pmb_number: String,
    pub address_record_type: String,
    pub default_address: bool,
    pub error_message: String,
    pub cass_processed: bool,
}

The USPS data for the address. uspsData is not guaranteed to be fully populated for every US or PR address sent to the Address Validation API. It’s recommended to integrate the backup address fields in the response if you utilize uspsData as the primary part of the response.

Fields

standardized_address: Option<UspsAddress>

USPS standardized address.

delivery_point_code: String

2 digit delivery point code

delivery_point_check_digit: String

The delivery point check digit. This number is added to the end of the delivery_point_barcode for mechanically scanned mail. Adding all the digits of the delivery_point_barcode, delivery_point_check_digit, postal code, and ZIP+4 together should yield a number divisible by 10.

dpv_confirmation: String

The possible values for DPV confirmation. Returns a single character or returns no value.

• N: Primary and any secondary number information failed to DPV confirm.
• D: Address was DPV confirmed for the primary number only, and the secondary number information was missing.
• S: Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed.
• Y: Address was DPV confirmed for primary and any secondary numbers.
• Empty: If the response does not contain a dpv_confirmation value, the address was not submitted for DPV confirmation.

dpv_footnote: String

The footnotes from delivery point validation. Multiple footnotes may be strung together in the same string.

• AA: Input address matched to the ZIP+4 file
• A1: Input address was not matched to the ZIP+4 file
• BB: Matched to DPV (all components)
• CC: Secondary number not matched and not required
• C1: Secondary number not matched but required
• N1: High-rise address missing secondary number
• M1: Primary number missing
• M3: Primary number invalid
• P1: Input address PO, RR or HC box number missing
• P3: Input address PO, RR, or HC Box number invalid
• F1: Input address matched to a military address
• G1: Input address matched to a general delivery address
• U1: Input address matched to a unique ZIP code
• PB: Input address matched to PBSA record
• RR: DPV confirmed address with PMB information
• R1: DPV confirmed address without PMB information
• R7: Carrier Route R777 or R779 record
• IA: Informed Address identified
• TA: Primary number matched by dropping a trailing alpha

dpv_cmra: String

Indicates if the address is a CMRA (Commercial Mail Receiving Agency)–a private business receiving mail for clients. Returns a single character.

• Y: The address is a CMRA
• N: The address is not a CMRA

dpv_vacant: String

Is this place vacant? Returns a single character.

• Y: The address is vacant
• N: The address is not vacant

dpv_no_stat: String

Is this a no stat address or an active address? No stat addresses are ones which are not continuously occupied or addresses that the USPS does not service. Returns a single character.

• Y: The address is not active
• N: The address is active

dpv_no_stat_reason_code: i32

Indicates the NoStat type. Returns a reason code as int.

• 1: IDA (Internal Drop Address) – Addresses that do not receive mail directly from the USPS but are delivered to a drop address that services them.
• 2: CDS - Addresses that have not yet become deliverable. For example, a new subdivision where lots and primary numbers have been determined, but no structure exists yet for occupancy.
• 3: Collision - Addresses that do not actually DPV confirm.
• 4: CMZ (College, Military and Other Types) - ZIP + 4 records USPS has incorporated into the data.
• 5: Regular - Indicates addresses not receiving delivery and the addresses are not counted as possible deliveries.
• 6: Secondary Required - The address requires secondary information.

dpv_drop: String

Flag indicates mail is delivered to a single receptable at a site. Returns a single character.

• Y: The mail is delivered to a single receptable at a site.
• N: The mail is not delivered to a single receptable at a site.

dpv_throwback: String

Indicates that mail is not delivered to the street address. Returns a single character.

• Y: The mail is not delivered to the street address.
• N: The mail is delivered to the street address.

dpv_non_delivery_days: String

Flag indicates mail delivery is not performed every day of the week. Returns a single character.

• Y: The mail delivery is not performed every day of the week.
• N: No indication the mail delivery is not performed every day of the week.

dpv_non_delivery_days_values: i32

Integer identifying non-delivery days. It can be interrogated using bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a non-delivery day

dpv_no_secure_location: String

Flag indicates door is accessible, but package will not be left due to security concerns. Returns a single character.

• Y: The package will not be left due to security concerns.
• N: No indication the package will not be left due to security concerns.

dpv_pbsa: String

Indicates the address was matched to PBSA record. Returns a single character.

• Y: The address was matched to PBSA record.
• N: The address was not matched to PBSA record.

dpv_door_not_accessible: String

Flag indicates addresses where USPS cannot knock on a door to deliver mail. Returns a single character.

• Y: The door is not accessible.
• N: No indication the door is not accessible.

dpv_enhanced_delivery_code: String

Indicates that more than one DPV return code is valid for the address. Returns a single character.

• Y: Address was DPV confirmed for primary and any secondary numbers.
• N: Primary and any secondary number information failed to DPV confirm.
• S: Address was DPV confirmed for the primary number only, and the secondary number information was present by not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required.
• D: Address was DPV confirmed for the primary number only, and the secondary number information was missing.
• R: Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided.

carrier_route: String

The carrier route code. A four character code consisting of a one letter prefix and a three digit route designator.

Prefixes:

• C: Carrier route (or city route)
• R: Rural route
• H: Highway Contract Route
• B: Post Office Box Section
• G: General delivery unit

carrier_route_indicator: String

Carrier route rate sort indicator.

ews_no_match: bool

The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.

post_office_city: String

Main post office city.

post_office_state: String

Main post office state.

abbreviated_city: String

Abbreviated city.

fips_county_code: String

FIPS county code.

county: String

County name.

elot_number: String

Enhanced Line of Travel (eLOT) number.

elot_flag: String

eLOT Ascending/Descending Flag (A/D).

lacs_link_return_code: String

LACSLink return code.

lacs_link_indicator: String

LACSLink indicator.

po_box_only_postal_code: bool

PO Box only postal code.

suitelink_footnote: String

Footnotes from matching a street or highrise record to suite information. If business name match is found, the secondary number is returned.

• A: SuiteLink record match, business address improved.
• 00: No match, business address is not improved.

pmb_designator: String

PMB (Private Mail Box) unit designator.

pmb_number: String

PMB (Private Mail Box) number;

address_record_type: String

Type of the address record that matches the input address.

• F: FIRM. This is a match to a Firm Record, which is the finest level of match available for an address.
• G: GENERAL DELIVERY. This is a match to a General Delivery record.
• H: BUILDING / APARTMENT. This is a match to a Building or Apartment record.
• P: POST OFFICE BOX. This is a match to a Post Office Box.
• R: RURAL ROUTE or HIGHWAY CONTRACT: This is a match to either a Rural Route or a Highway Contract record, both of which may have associated Box Number ranges.
• S: STREET RECORD: This is a match to a Street record containing a valid primary number range.

default_address: bool

Indicator that a default address was found, but more specific addresses exists.

error_message: String

Error message for USPS data retrieval. This is populated when USPS processing is suspended because of the detection of artificially created addresses.

The USPS data fields might not be populated when this error is present.

cass_processed: bool

Indicator that the request has been CASS processed.

Trait Implementations

impl Clone for UspsData

fn clone(&self) -> UspsData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UspsData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UspsData

fn default() -> Self

Returns the “default value” for a type.

impl Message for UspsData

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for UspsData

fn eq(&self, other: &UspsData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UspsData