Copyright	License : GPL-3
Maintainer	hahn@geoinfo.tuwien.ac.at
Stability	experimental
Safe Haskell	None
Language	Haskell98

RevGeocoder

Description

Requests the http://geocoder.opencagedata.com reverse geocoding service to transfer latitude and longitude values into an address.

Synopsis

Documentation

data QueryParameters Source

data type including all possible parameters OpenCage API offers

Constructors

QueryParameters
Fields para_latitude :: Double latitude value to reverse geocode para_longitude :: Double longitude value to reverse geocode para_key :: Text OpenCage key para_language :: Maybe Text language for the result: IETF format language code para_pretty :: Maybe Text should the result be pretty printed ? para_jsonp :: Maybe Text should the result be included into a JSON function ?

Instances

Show QueryParameters
Generic QueryParameters
type Rep QueryParameters

defaultParams :: QueryParameters Source

minimal example of QueryParameters can be used to create your own parameters

type GeoCageDeveloperKey = Text Source

type GeoCageLatitude = Double Source

type GeoCageLongitude = Double Source

reverseGeocode Source

Arguments

:: GeoCageLatitude	latitude value to reverse geocode
-> GeoCageLongitude	longitude value to reverse geocode
-> GeoCageDeveloperKey	OpenCage key
-> IO [Result]	list of results, empty if an error occured

reverse geocode latitude and longitude, returns a list of Result values

reverseGeocodeWith Source

Arguments

:: QueryParameters	parameters for the request
-> IO [Result]	list of results, empty if an error occured

reverse geocode passing all parameters via the QueryParameters type

getReverseAPIResponse Source

Arguments

:: GeoCageLatitude	latitude value to reverse geocode
-> GeoCageLongitude	longitude value to reverse geocode
-> GeoCageDeveloperKey	OpenCage key
-> IO (Maybe ResponseBody)	if successful Just a ResponseBody, otherwise Nothing

reverse geocode latitude and longitude, returns the whole Response

getReverseAPIResponseWith Source

Arguments

:: QueryParameters	parameters for the request
-> IO (Maybe ResponseBody)	if successful Just a ResponseBody, otherwise Nothing

reverse geocode passing all parameters via the QueryParameters type

data ResponseBody Source

data type respecting OpenCage response encoded as JSON

Constructors

ResponseBody
Fields licenses :: [License] rate :: Rate results :: [Result] status :: Status thanks :: Text timestamp :: Timestamp total_results :: Integer we_are_hiring :: Text

Instances

Show ResponseBody
Generic ResponseBody
FromJSON ResponseBody
type Rep ResponseBody

data Result Source

Constructors

Result
Fields bounds :: Bounds components :: Components confidence :: Integer formatted :: Text geometry :: Location

Instances

Show Result
Generic Result
FromJSON Result
type Rep Result

data License Source

Constructors

License
Fields name :: Text url :: Text

Instances

Show License
Generic License
FromJSON License
type Rep License

data Rate Source

Constructors

Rate
Fields limit :: Integer remaining :: Integer reset :: Double

Instances

Show Rate
Generic Rate
FromJSON Rate
type Rep Rate

data Status Source

Constructors

Status
Fields code :: Integer message :: Text

Instances

Show Status
Generic Status
FromJSON Status
type Rep Status

data Timestamp Source

Constructors

Timestamp
Fields created_http :: Text created_unix :: Integer

Instances

Show Timestamp
Generic Timestamp
FromJSON Timestamp
type Rep Timestamp

data Components Source

Constructors

Components
Fields country :: Text country_code :: Text county :: Text state :: Text city :: Text road :: Text clothes :: Text

Instances

Show Components
Generic Components
FromJSON Components	not all components are included into the response, if so there is an empty string as default value.
type Rep Components

data Location Source

Constructors

Location
Fields lat :: Double lng :: Double

Instances

Show Location
Generic Location
FromJSON Location
type Rep Location

data Bounds Source

Constructors

Bounds
Fields northeast :: Location southwest :: Location

Instances

Show Bounds
Generic Bounds
FromJSON Bounds
type Rep Bounds