Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

body

body: { code: 2000; message: "Success"; result: { administrative_county: string; building_name: string; building_number: string; country: string; country_iso: "GBR" | "IMN" | "JEY" | "GGY" | "USA" | "PRI" | "GUM"; county: string; dataset: "paf" | "mr" | "nyb" | "usps"; delivery_point_suffix: string; department_name: string; dependant_locality: string; dependant_thoroughfare: string; district: string; double_dependant_locality: string; eastings: number | ""; id: string; latitude: number | ""; line_1: string; line_2: string; line_3: string; longitude: number | ""; northings: number | ""; organisation_name: string; po_box: string; post_town: string; postal_county: string; postcode: string; postcode_inward: string; postcode_outward: string; postcode_type: "S" | "L"; premise: string; su_organisation_indicator: string; sub_building_name: string; thoroughfare: string; traditional_county: string; udprn: number; umprn: number | ""; uprn: string; ward: string } & { dataset?: "paf" | "mr" | "nyb" | "usps" } }

Type declaration

  • code: 2000

    Format: int32

  • message: "Success"
  • result: { administrative_county: string; building_name: string; building_number: string; country: string; country_iso: "GBR" | "IMN" | "JEY" | "GGY" | "USA" | "PRI" | "GUM"; county: string; dataset: "paf" | "mr" | "nyb" | "usps"; delivery_point_suffix: string; department_name: string; dependant_locality: string; dependant_thoroughfare: string; district: string; double_dependant_locality: string; eastings: number | ""; id: string; latitude: number | ""; line_1: string; line_2: string; line_3: string; longitude: number | ""; northings: number | ""; organisation_name: string; po_box: string; post_town: string; postal_county: string; postcode: string; postcode_inward: string; postcode_outward: string; postcode_type: "S" | "L"; premise: string; su_organisation_indicator: string; sub_building_name: string; thoroughfare: string; traditional_county: string; udprn: number; umprn: number | ""; uprn: string; ward: string } & { dataset?: "paf" | "mr" | "nyb" | "usps" }

header

header: StringMap

httpRequest

httpRequest: HttpRequest

httpStatus

httpStatus: number

Optional metadata

metadata: Metadata