Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

body

body: { code: 2000; message: "Success"; result: { address_secondary_abbreviation: string; base_alternate_code: "" | "A" | "B"; building_or_firm_name: string; carrier_route_id: string; carrier_route_rate_sortation: string; city: string; city_abbreviation: string; city_state_mailing_name_indicator: string; city_state_name_facility_code: "" | "S" | "P" | "B" | "C" | "N" | "U" | "Y"; congressional_district_number: string | number; country?: "United States" | "Guam" | "Puerto Rico"; country_iso: "USA" | "PRI" | "GUM"; county: string; county_number: string | number; dataset: "usps"; finance_number: string | number; government_building_indicator: "" | "G" | "F" | "A" | "B" | "C" | "D" | "E"; id: string; lacs_status_indicator: "" | "L"; last_line: string; line_1: string; line_2: string; municipality_city_state_key: string; plus_4_code: string; preferred_city: string; preferred_last_line_city_state_key: string; primary_number: string; record_type_code: "" | "S" | "G" | "H" | "F" | "P" | "R" | "M"; secondary_number: string; state: string; state_abbreviation: string; street_name: string; street_post_directional_abbreviation: string; street_pre_directional_abbreviation: string; street_suffix_abbreviation: string; update_key_number: string; urbanization_city_state_key: string; zip_classification_code: "" | "P" | "M" | "U"; zip_code: string; zip_plus_4_code: string } | { address_secondary_abbreviation: ""; base_alternate_code: ""; building_or_firm_name: ""; carrier_route_id: ""; carrier_route_rate_sortation: ""; city: string; city_abbreviation: string; city_state_mailing_name_indicator: ""; city_state_name_facility_code: ""; congressional_district_number: ""; country?: string; country_iso: "GBR" | "IMN" | "JEY" | "GGY" | "USA" | "PRI" | "GUM"; county: string; county_number: ""; dataset: "paf" | "mr" | "nyb" | "usps"; finance_number: ""; government_building_indicator: ""; id: string; lacs_status_indicator: ""; last_line: ""; line_1: string; line_2: string; municipality_city_state_key: ""; plus_4_code: ""; preferred_city: ""; preferred_last_line_city_state_key: ""; primary_number: ""; record_type_code: ""; secondary_number: ""; state: string; state_abbreviation: string; street_name: ""; street_post_directional_abbreviation: ""; street_pre_directional_abbreviation: ""; street_suffix_abbreviation: ""; update_key_number: ""; urbanization_city_state_key: ""; zip_classification_code: ""; zip_code: string; zip_plus_4_code: string } }

Type declaration

  • code: 2000

    Format: int32

  • message: "Success"
  • result: { address_secondary_abbreviation: string; base_alternate_code: "" | "A" | "B"; building_or_firm_name: string; carrier_route_id: string; carrier_route_rate_sortation: string; city: string; city_abbreviation: string; city_state_mailing_name_indicator: string; city_state_name_facility_code: "" | "S" | "P" | "B" | "C" | "N" | "U" | "Y"; congressional_district_number: string | number; country?: "United States" | "Guam" | "Puerto Rico"; country_iso: "USA" | "PRI" | "GUM"; county: string; county_number: string | number; dataset: "usps"; finance_number: string | number; government_building_indicator: "" | "G" | "F" | "A" | "B" | "C" | "D" | "E"; id: string; lacs_status_indicator: "" | "L"; last_line: string; line_1: string; line_2: string; municipality_city_state_key: string; plus_4_code: string; preferred_city: string; preferred_last_line_city_state_key: string; primary_number: string; record_type_code: "" | "S" | "G" | "H" | "F" | "P" | "R" | "M"; secondary_number: string; state: string; state_abbreviation: string; street_name: string; street_post_directional_abbreviation: string; street_pre_directional_abbreviation: string; street_suffix_abbreviation: string; update_key_number: string; urbanization_city_state_key: string; zip_classification_code: "" | "P" | "M" | "U"; zip_code: string; zip_plus_4_code: string } | { address_secondary_abbreviation: ""; base_alternate_code: ""; building_or_firm_name: ""; carrier_route_id: ""; carrier_route_rate_sortation: ""; city: string; city_abbreviation: string; city_state_mailing_name_indicator: ""; city_state_name_facility_code: ""; congressional_district_number: ""; country?: string; country_iso: "GBR" | "IMN" | "JEY" | "GGY" | "USA" | "PRI" | "GUM"; county: string; county_number: ""; dataset: "paf" | "mr" | "nyb" | "usps"; finance_number: ""; government_building_indicator: ""; id: string; lacs_status_indicator: ""; last_line: ""; line_1: string; line_2: string; municipality_city_state_key: ""; plus_4_code: ""; preferred_city: ""; preferred_last_line_city_state_key: ""; primary_number: ""; record_type_code: ""; secondary_number: ""; state: string; state_abbreviation: string; street_name: ""; street_post_directional_abbreviation: ""; street_pre_directional_abbreviation: ""; street_suffix_abbreviation: ""; update_key_number: ""; urbanization_city_state_key: ""; zip_classification_code: ""; zip_code: string; zip_plus_4_code: string }

header

header: StringMap

httpRequest

httpRequest: HttpRequest

httpStatus

httpStatus: number

Optional metadata

metadata: Metadata