place

package

v0.1868.126 Latest Latest Go to latest Published: Aug 26, 2025 License: MIT Imports: 6 Imported by: 0

Documentation ¶

Overview ¶

Package place provides a client for Ordnance Survey's Places API.

Index ¶

Variables
type Address
type AddressDetails
- func (ad *AddressDetails) TransformToAddress() Address
type BadRequestError
- func (b BadRequestError) Error() string
type Client
- func NewClient(baseUrl, apiKey string, httpClient Doer) *Client
- func (c *Client) LookupPostcode(ctx context.Context, postcode string) ([]Address, error)
type Doer
type InternationalAddress
- func (a InternationalAddress) ToAddress() Address
type ResultSet

Constants ¶

This section is empty.

Variables ¶

View Source

var Countries = []string{}/* 195 elements not displayed */

Taken from https://www.gov.uk/government/publications/geographical-names-and-information

Functions ¶

This section is empty.

Types ¶

type Address ¶

type Address struct {
	Line1      string `json:"line1"`
	Line2      string `json:"line2" relatedhash:"-"`
	Line3      string `json:"line3" relatedhash:"-"`
	TownOrCity string `json:"town" relatedhash:"-"`
	Postcode   string `json:"postcode"`
	Country    string `json:"country" relatedhash:"-"`
}

func (Address) Encode ¶

func (a Address) Encode() string

func (Address) Lines ¶

func (a Address) Lines() []string

func (Address) String ¶

func (a Address) String() string

type AddressDetails ¶ added in v0.1280.0

type AddressDetails struct {
	Address           string `json:"ADDRESS"`
	SubBuildingName   string `json:"SUB_BUILDING_NAME"`
	BuildingName      string `json:"BUILDING_NAME"`
	BuildingNumber    string `json:"BUILDING_NUMBER"`
	ThoroughFareName  string `json:"THOROUGHFARE_NAME"`
	DependentLocality string `json:"DEPENDENT_LOCALITY"`
	Town              string `json:"POST_TOWN"`
	Postcode          string `json:"POSTCODE"`
}

func (*AddressDetails) TransformToAddress ¶ added in v0.1280.0

func (ad *AddressDetails) TransformToAddress() Address

type BadRequestError ¶

type BadRequestError struct {
	Statuscode int    `json:"statuscode"`
	Message    string `json:"message"`
}

func (BadRequestError) Error ¶

func (b BadRequestError) Error() string

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(baseUrl, apiKey string, httpClient Doer) *Client

func (*Client) LookupPostcode ¶

func (c *Client) LookupPostcode(ctx context.Context, postcode string) ([]Address, error)

type Doer ¶

type Doer interface {
	Do(*http.Request) (*http.Response, error)
}

type InternationalAddress ¶ added in v0.1800.0

type InternationalAddress struct {
	ApartmentNumber string `json:"apartmentNumber"`
	BuildingNumber  string `json:"buildingNumber"`
	BuildingName    string `json:"buildingName"`
	StreetName      string `json:"streetName"`
	Town            string `json:"town"`
	Region          string `json:"region"`
	PostalCode      string `json:"postalCode"`
	Country         string `json:"country"`
}

func (InternationalAddress) ToAddress ¶ added in v0.1800.0

func (a InternationalAddress) ToAddress() Address

type ResultSet ¶

type ResultSet struct {
	AddressDetails AddressDetails `json:"DPA"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL