nbn

Documentation

Index

• type Address
• type AddressDetail
  • func Lookup(id string) (*AddressDetail, error)
• type Suggestion
  • func Search(address Address) ([]Suggestion, error)

Types

type Address

type Address struct {
	Street   string
	Suburb   string
	Postcode string
	State    string
}

Address is input for the initial search

type AddressDetail

type AddressDetail struct {
	AddressStatus         string
	ServiceType           string
	ServiceStatus         string
	TechType              string
	ServiceabilityMessage string
	StatusMessage         string
}

AddressDetail is returned from the final lookup with details on the LOC

func Lookup

func Lookup(id string) (*AddressDetail, error)

Lookup based on NBNco ID

type Suggestion

type Suggestion struct {
	ID               string
	FormattedAddress string
	Latitude         float64
	Longitude        float64
}

Suggestion is returned from the initial search with potential matches

func Search

func Search(address Address) ([]Suggestion, error)

Search for address, returning nbnco suggestions