place

Documentation

Overview

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

Index

• type Address
  • func (a Address) Encode() string
  • func (a Address) Lines() []string
  • func (a Address) String() string
• 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 ResultSet

Types

type Address

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

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

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

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 ResultSet

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