postcodenl

Documentation

Index

• Variables
• type API
  • func New(key, secret string) API
  • func NewMock() API
• type Data
• type Exception
  • func (e Exception) Error() string

Variables

var (
	ErrInvalidPostcode    = errors.New("invalid postcode")
	ErrPostcodenlApiError = errors.New("postcode API error")
)

Types

type API

type API interface {
	Check(postcode string, housenumber uint64) (*Data, error)
}

func New

func New(key, secret string) API

New creates a new API instance that wraps postcode.nl using provided key and secret

func NewMock

func NewMock() API

NewMock creates a new API instance that returns fake data

type Data

type Data struct {
	Street                 string   `json:"street"`
	HouseNumber            uint64   `json:"houseNumber"`
	HouseNumberAddition    string   `json:"houseNumberAddition"`
	Postcode               string   `json:"postcode"`
	City                   string   `json:"city"`
	Municipality           string   `json:"municipality"`
	Province               string   `json:"province"`
	RdX                    int      `json:"rdX"`
	RdY                    int      `json:"rdY"`
	Latitude               float64  `json:"latitude"`
	Longitude              float64  `json:"longitude"`
	BagNumberDesignationID string   `json:"bagNumberDesignationId"`
	BagAddressableObjectID string   `json:"bagAddressableObjectId"`
	AddressType            string   `json:"addressType"`
	Purposes               []string `json:"purposes"`
	SurfaceArea            int      `json:"surfaceArea"`
	HouseNumberAdditions   []string `json:"houseNumberAdditions"`
}

Data provided from postcode.nl API's

type Exception

type Exception struct {
	Exception   string `json:"exception"`
	ExceptionID string `json:"exceptionId"`
}

func (Exception) Error

func (e Exception) Error() string