Interface GbrResponse

Type declaration

• code: 2000

  Format: int32

• message: "Success"

• result: ({ administrative_county: string; building_name: string; building_number: string; country: string; country_iso: string; country_iso_2: string; county: string; county_code: string; dataset: string; delivery_point_suffix: string; department_name: string; dependant_locality: string; dependant_thoroughfare: string; district: string; double_dependant_locality: string; eastings: string | number; id: string; language: string; latitude: string | number; line_1: string; line_2: string; line_3: string; longitude: string | number; northings: string | 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: string | number; uprn: string; ward: string } & { country?: "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man"; country_iso?: "GBR" | "IMN" | "JEY" | "GGY"; country_iso_2?: "GB" | "IM" | "JE" | "GG"; dataset?: "paf"; language?: "en" }) | ({ administrative_county: string; building_name: string; building_number: string; country: string; country_iso: string; country_iso_2: string; county: string; county_code: string; dataset: string; delivery_point_suffix: string; department_name: string; dependant_locality: string; dependant_thoroughfare: string; district: string; double_dependant_locality: string; eastings: string | number; id: string; language: string; latitude: string | number; line_1: string; line_2: string; line_3: string; longitude: string | number; northings: string | 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: string | number; uprn: string; ward: string } & { country?: "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man"; country_iso?: "GBR" | "IMN" | "JEY" | "GGY"; country_iso_2?: "GB" | "IM" | "JE" | "GG"; dataset?: "mr"; language?: "en" }) | ({ administrative_county: string; building_name: string; building_number: string; country: string; country_iso: string; country_iso_2: string; county: string; county_code: string; dataset: string; delivery_point_suffix: string; department_name: string; dependant_locality: string; dependant_thoroughfare: string; district: string; double_dependant_locality: string; eastings: string | number; id: string; language: string; latitude: string | number; line_1: string; line_2: string; line_3: string; longitude: string | number; northings: string | 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: string | number; uprn: string; ward: string } & { country?: "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man"; country_iso?: "GBR" | "IMN" | "JEY" | "GGY"; country_iso_2?: "GB" | "IM" | "JE" | "GG"; dataset?: "nyb"; language?: "en" }) | ({ administrative_county: string; building_name: string; building_number: string; country: string; country_iso: string; country_iso_2: string; county: string; county_code: string; dataset: string; delivery_point_suffix: string; department_name: string; dependant_locality: string; dependant_thoroughfare: string; district: string; double_dependant_locality: string; eastings: string | number; id: string; language: string; latitude: string | number; line_1: string; line_2: string; line_3: string; longitude: string | number; northings: string | 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: string | number; uprn: string; ward: string } & { country?: "Wales"; country_iso?: "GBR"; country_iso_2?: "GB"; dataset?: "pafw"; language?: "cy" }) | ({ administrative_county: string; building_name: string; building_number: string; country: string; country_iso: string; country_iso_2: string; county: string; county_code: string; dataset: string; delivery_point_suffix: string; department_name: string; dependant_locality: string; dependant_thoroughfare: string; district: string; double_dependant_locality: string; eastings: string | number; id: string; language: string; latitude: string | number; line_1: string; line_2: string; line_3: string; longitude: string | number; northings: string | 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: string | number; uprn: string; ward: string } & { country?: "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man"; country_iso?: "GBR" | "IMN" | "JEY" | "GGY"; country_iso_2?: "GB" | "IM" | "JE" | "GG"; dataset?: "pafa"; language?: "en" }) | { administrative_county: ""; building_name: ""; building_number: ""; country: "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man" | "United States" | "Guam" | "Puerto Rico" | "Ireland"; country_iso: "GBR" | "IMN" | "JEY" | "GGY" | "USA" | "PRI" | "GUM" | "IRL"; country_iso_2: "GB" | "IM" | "JE" | "GG" | "US" | "PR" | "GU" | "IE"; county: string; county_code: string; dataset: "paf" | "mr" | "nyb" | "pafw" | "pafa" | "usps" | "ecaf" | "ecad"; delivery_point_suffix: ""; department_name: ""; dependant_locality: ""; dependant_thoroughfare: ""; district: ""; double_dependant_locality: ""; eastings: ""; id: string; language: "en" | "cy" | "ga"; latitude: string | number; line_1: string; line_2: string; line_3: string; longitude: string | number; northings: ""; organisation_name: ""; po_box: ""; post_town: string; postal_county: ""; postcode: string; postcode_inward: ""; postcode_outward: ""; postcode_type: ""; premise: ""; su_organisation_indicator: ""; sub_building_name: ""; thoroughfare: ""; traditional_county: ""; udprn: ""; umprn: ""; uprn: ""; ward: "" }