Geocoding API

Default

decode

decode text and return any codelist values


/geocoding/v1/searchterm/decode

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/geocoding/v1/searchterm/decode?text=&size=&boundary.rect.min_lon=&boundary.rect.max_lon=&boundary.rect.min_lat=&boundary.rect.max_lat=&focus.point.lon=&focus.point.lat=&boundary.circle.lon=&boundary.circle.lat=&boundary.circle.radius=&sources=&layers=&lang=&exclude=&crs=&request-crs=&scale.denominator="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String text = text_example; // String | search term
        Integer size = 56; // Integer | maximum response feature count
        Double boundaryPeriodrectPeriodminLon = 1.2; // Double | min longitude (or E depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodmaxLon = 1.2; // Double | max longitude (or E depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodminLat = 1.2; // Double | min latitude (or N depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodmaxLat = 1.2; // Double | max latitude (or N depending on request-crs) for request boundary rectangle
        Double focusPeriodpointPeriodlon = 1.2; // Double | longitude (or E depending on request-crs) for request focus point
        Double focusPeriodpointPeriodlat = 1.2; // Double | latitude (or N depending on request-crs) for request focus point
        Double boundaryPeriodcirclePeriodlon = 1.2; // Double | longitude (or E depending on request-crs) for request circle center
        Double boundaryPeriodcirclePeriodlat = 1.2; // Double | latitude (or N depending on request-crs) for request circle center
        Double boundaryPeriodcirclePeriodradius = 1.2; // Double | search radius in meters (default is 1000m, results are sorted nearest first)
        String sources = sources_example; // String | comma separated list of sources (if none given defaults are used)
        String layers = layers_example; // String | (this parameter has no effect in this service)
        String lang = lang_example; // String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
        String exclude = exclude_example; // String | exclusion map for codelist matching - This is a Pelias API extension
        String crs = crs_example; // String | output CRS code for geometries (default 4326) - This is a Pelias API extension
        String requestCrs = requestCrs_example; // String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension
        Integer scalePerioddenominator = 56; // Integer | used only for mapsheets atm  - This is a Pelias API extension
        try {
            peliasResponseFeatureCollectionGeoJSON result = apiInstance.decode(text, size, boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat, focusPeriodpointPeriodlon, focusPeriodpointPeriodlat, boundaryPeriodcirclePeriodlon, boundaryPeriodcirclePeriodlat, boundaryPeriodcirclePeriodradius, sources, layers, lang, exclude, crs, requestCrs, scalePerioddenominator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#decode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String text = text_example; // String | search term
        Integer size = 56; // Integer | maximum response feature count
        Double boundaryPeriodrectPeriodminLon = 1.2; // Double | min longitude (or E depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodmaxLon = 1.2; // Double | max longitude (or E depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodminLat = 1.2; // Double | min latitude (or N depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodmaxLat = 1.2; // Double | max latitude (or N depending on request-crs) for request boundary rectangle
        Double focusPeriodpointPeriodlon = 1.2; // Double | longitude (or E depending on request-crs) for request focus point
        Double focusPeriodpointPeriodlat = 1.2; // Double | latitude (or N depending on request-crs) for request focus point
        Double boundaryPeriodcirclePeriodlon = 1.2; // Double | longitude (or E depending on request-crs) for request circle center
        Double boundaryPeriodcirclePeriodlat = 1.2; // Double | latitude (or N depending on request-crs) for request circle center
        Double boundaryPeriodcirclePeriodradius = 1.2; // Double | search radius in meters (default is 1000m, results are sorted nearest first)
        String sources = sources_example; // String | comma separated list of sources (if none given defaults are used)
        String layers = layers_example; // String | (this parameter has no effect in this service)
        String lang = lang_example; // String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
        String exclude = exclude_example; // String | exclusion map for codelist matching - This is a Pelias API extension
        String crs = crs_example; // String | output CRS code for geometries (default 4326) - This is a Pelias API extension
        String requestCrs = requestCrs_example; // String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension
        Integer scalePerioddenominator = 56; // Integer | used only for mapsheets atm  - This is a Pelias API extension
        try {
            peliasResponseFeatureCollectionGeoJSON result = apiInstance.decode(text, size, boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat, focusPeriodpointPeriodlon, focusPeriodpointPeriodlat, boundaryPeriodcirclePeriodlon, boundaryPeriodcirclePeriodlat, boundaryPeriodcirclePeriodradius, sources, layers, lang, exclude, crs, requestCrs, scalePerioddenominator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#decode");
            e.printStackTrace();
        }
    }
}
String *text = text_example; // search term (optional) (default to null)
Integer *size = 56; // maximum response feature count (optional) (default to 10)
Double *boundaryPeriodrectPeriodminLon = 1.2; // min longitude (or E depending on request-crs) for request boundary rectangle (optional) (default to null)
Double *boundaryPeriodrectPeriodmaxLon = 1.2; // max longitude (or E depending on request-crs) for request boundary rectangle (optional) (default to null)
Double *boundaryPeriodrectPeriodminLat = 1.2; // min latitude (or N depending on request-crs) for request boundary rectangle (optional) (default to null)
Double *boundaryPeriodrectPeriodmaxLat = 1.2; // max latitude (or N depending on request-crs) for request boundary rectangle (optional) (default to null)
Double *focusPeriodpointPeriodlon = 1.2; // longitude (or E depending on request-crs) for request focus point (optional) (default to null)
Double *focusPeriodpointPeriodlat = 1.2; // latitude (or N depending on request-crs) for request focus point (optional) (default to null)
Double *boundaryPeriodcirclePeriodlon = 1.2; // longitude (or E depending on request-crs) for request circle center (optional) (default to null)
Double *boundaryPeriodcirclePeriodlat = 1.2; // latitude (or N depending on request-crs) for request circle center (optional) (default to null)
Double *boundaryPeriodcirclePeriodradius = 1.2; // search radius in meters (default is 1000m, results are sorted nearest first) (optional) (default to null)
String *sources = sources_example; // comma separated list of sources (if none given defaults are used) (optional) (default to null)
String *layers = layers_example; // (this parameter has no effect in this service) (optional) (default to null)
String *lang = lang_example; // locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension (optional) (default to fin)
String *exclude = exclude_example; // exclusion map for codelist matching - This is a Pelias API extension (optional) (default to null)
String *crs = crs_example; // output CRS code for geometries (default 4326) - This is a Pelias API extension (optional) (default to http://www.opengis.net/def/crs/EPSG/0/4326)
String *requestCrs = requestCrs_example; // request CRS for request parameters (boundary,focus) - This is a Pelias API extension (optional) (default to http://www.opengis.net/def/crs/EPSG/0/4326)
Integer *scalePerioddenominator = 56; // used only for mapsheets atm  - This is a Pelias API extension (optional) (default to 5000)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// decode text and return any codelist values
[apiInstance decodeWith:text
    size:size
    boundaryPeriodrectPeriodminLon:boundaryPeriodrectPeriodminLon
    boundaryPeriodrectPeriodmaxLon:boundaryPeriodrectPeriodmaxLon
    boundaryPeriodrectPeriodminLat:boundaryPeriodrectPeriodminLat
    boundaryPeriodrectPeriodmaxLat:boundaryPeriodrectPeriodmaxLat
    focusPeriodpointPeriodlon:focusPeriodpointPeriodlon
    focusPeriodpointPeriodlat:focusPeriodpointPeriodlat
    boundaryPeriodcirclePeriodlon:boundaryPeriodcirclePeriodlon
    boundaryPeriodcirclePeriodlat:boundaryPeriodcirclePeriodlat
    boundaryPeriodcirclePeriodradius:boundaryPeriodcirclePeriodradius
    sources:sources
    layers:layers
    lang:lang
    exclude:exclude
    crs:crs
    requestCrs:requestCrs
    scalePerioddenominator:scalePerioddenominator
              completionHandler: ^(peliasResponseFeatureCollectionGeoJSON output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GeocodingApi = require('geocoding_api');

var api = new GeocodingApi.DefaultApi()
var opts = {
  'text': text_example, // {String} search term
  'size': 56, // {Integer} maximum response feature count
  'boundaryPeriodrectPeriodminLon': 1.2, // {Double} min longitude (or E depending on request-crs) for request boundary rectangle
  'boundaryPeriodrectPeriodmaxLon': 1.2, // {Double} max longitude (or E depending on request-crs) for request boundary rectangle
  'boundaryPeriodrectPeriodminLat': 1.2, // {Double} min latitude (or N depending on request-crs) for request boundary rectangle
  'boundaryPeriodrectPeriodmaxLat': 1.2, // {Double} max latitude (or N depending on request-crs) for request boundary rectangle
  'focusPeriodpointPeriodlon': 1.2, // {Double} longitude (or E depending on request-crs) for request focus point
  'focusPeriodpointPeriodlat': 1.2, // {Double} latitude (or N depending on request-crs) for request focus point
  'boundaryPeriodcirclePeriodlon': 1.2, // {Double} longitude (or E depending on request-crs) for request circle center
  'boundaryPeriodcirclePeriodlat': 1.2, // {Double} latitude (or N depending on request-crs) for request circle center
  'boundaryPeriodcirclePeriodradius': 1.2, // {Double} search radius in meters (default is 1000m, results are sorted nearest first)
  'sources': sources_example, // {String} comma separated list of sources (if none given defaults are used)
  'layers': layers_example, // {String} (this parameter has no effect in this service)
  'lang': lang_example, // {String} locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
  'exclude': exclude_example, // {String} exclusion map for codelist matching - This is a Pelias API extension
  'crs': crs_example, // {String} output CRS code for geometries (default 4326) - This is a Pelias API extension
  'requestCrs': requestCrs_example, // {String} request CRS for request parameters (boundary,focus) - This is a Pelias API extension
  'scalePerioddenominator': 56 // {Integer} used only for mapsheets atm  - This is a Pelias API extension
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.decode(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class decodeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var text = text_example;  // String | search term (optional)  (default to null)
            var size = 56;  // Integer | maximum response feature count (optional)  (default to 10)
            var boundaryPeriodrectPeriodminLon = 1.2;  // Double | min longitude (or E depending on request-crs) for request boundary rectangle (optional)  (default to null)
            var boundaryPeriodrectPeriodmaxLon = 1.2;  // Double | max longitude (or E depending on request-crs) for request boundary rectangle (optional)  (default to null)
            var boundaryPeriodrectPeriodminLat = 1.2;  // Double | min latitude (or N depending on request-crs) for request boundary rectangle (optional)  (default to null)
            var boundaryPeriodrectPeriodmaxLat = 1.2;  // Double | max latitude (or N depending on request-crs) for request boundary rectangle (optional)  (default to null)
            var focusPeriodpointPeriodlon = 1.2;  // Double | longitude (or E depending on request-crs) for request focus point (optional)  (default to null)
            var focusPeriodpointPeriodlat = 1.2;  // Double | latitude (or N depending on request-crs) for request focus point (optional)  (default to null)
            var boundaryPeriodcirclePeriodlon = 1.2;  // Double | longitude (or E depending on request-crs) for request circle center (optional)  (default to null)
            var boundaryPeriodcirclePeriodlat = 1.2;  // Double | latitude (or N depending on request-crs) for request circle center (optional)  (default to null)
            var boundaryPeriodcirclePeriodradius = 1.2;  // Double | search radius in meters (default is 1000m, results are sorted nearest first) (optional)  (default to null)
            var sources = sources_example;  // String | comma separated list of sources (if none given defaults are used) (optional)  (default to null)
            var layers = layers_example;  // String | (this parameter has no effect in this service) (optional)  (default to null)
            var lang = lang_example;  // String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension (optional)  (default to fin)
            var exclude = exclude_example;  // String | exclusion map for codelist matching - This is a Pelias API extension (optional)  (default to null)
            var crs = crs_example;  // String | output CRS code for geometries (default 4326) - This is a Pelias API extension (optional)  (default to http://www.opengis.net/def/crs/EPSG/0/4326)
            var requestCrs = requestCrs_example;  // String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension (optional)  (default to http://www.opengis.net/def/crs/EPSG/0/4326)
            var scalePerioddenominator = 56;  // Integer | used only for mapsheets atm  - This is a Pelias API extension (optional)  (default to 5000)

            try
            {
                // decode text and return any codelist values
                peliasResponseFeatureCollectionGeoJSON result = apiInstance.decode(text, size, boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat, focusPeriodpointPeriodlon, focusPeriodpointPeriodlat, boundaryPeriodcirclePeriodlon, boundaryPeriodcirclePeriodlat, boundaryPeriodcirclePeriodradius, sources, layers, lang, exclude, crs, requestCrs, scalePerioddenominator);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.decode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$text = text_example; // String | search term
$size = 56; // Integer | maximum response feature count
$boundaryPeriodrectPeriodminLon = 1.2; // Double | min longitude (or E depending on request-crs) for request boundary rectangle
$boundaryPeriodrectPeriodmaxLon = 1.2; // Double | max longitude (or E depending on request-crs) for request boundary rectangle
$boundaryPeriodrectPeriodminLat = 1.2; // Double | min latitude (or N depending on request-crs) for request boundary rectangle
$boundaryPeriodrectPeriodmaxLat = 1.2; // Double | max latitude (or N depending on request-crs) for request boundary rectangle
$focusPeriodpointPeriodlon = 1.2; // Double | longitude (or E depending on request-crs) for request focus point
$focusPeriodpointPeriodlat = 1.2; // Double | latitude (or N depending on request-crs) for request focus point
$boundaryPeriodcirclePeriodlon = 1.2; // Double | longitude (or E depending on request-crs) for request circle center
$boundaryPeriodcirclePeriodlat = 1.2; // Double | latitude (or N depending on request-crs) for request circle center
$boundaryPeriodcirclePeriodradius = 1.2; // Double | search radius in meters (default is 1000m, results are sorted nearest first)
$sources = sources_example; // String | comma separated list of sources (if none given defaults are used)
$layers = layers_example; // String | (this parameter has no effect in this service)
$lang = lang_example; // String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
$exclude = exclude_example; // String | exclusion map for codelist matching - This is a Pelias API extension
$crs = crs_example; // String | output CRS code for geometries (default 4326) - This is a Pelias API extension
$requestCrs = requestCrs_example; // String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension
$scalePerioddenominator = 56; // Integer | used only for mapsheets atm  - This is a Pelias API extension

try {
    $result = $api_instance->decode($text, $size, $boundaryPeriodrectPeriodminLon, $boundaryPeriodrectPeriodmaxLon, $boundaryPeriodrectPeriodminLat, $boundaryPeriodrectPeriodmaxLat, $focusPeriodpointPeriodlon, $focusPeriodpointPeriodlat, $boundaryPeriodcirclePeriodlon, $boundaryPeriodcirclePeriodlat, $boundaryPeriodcirclePeriodradius, $sources, $layers, $lang, $exclude, $crs, $requestCrs, $scalePerioddenominator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->decode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $text = text_example; # String | search term
my $size = 56; # Integer | maximum response feature count
my $boundaryPeriodrectPeriodminLon = 1.2; # Double | min longitude (or E depending on request-crs) for request boundary rectangle
my $boundaryPeriodrectPeriodmaxLon = 1.2; # Double | max longitude (or E depending on request-crs) for request boundary rectangle
my $boundaryPeriodrectPeriodminLat = 1.2; # Double | min latitude (or N depending on request-crs) for request boundary rectangle
my $boundaryPeriodrectPeriodmaxLat = 1.2; # Double | max latitude (or N depending on request-crs) for request boundary rectangle
my $focusPeriodpointPeriodlon = 1.2; # Double | longitude (or E depending on request-crs) for request focus point
my $focusPeriodpointPeriodlat = 1.2; # Double | latitude (or N depending on request-crs) for request focus point
my $boundaryPeriodcirclePeriodlon = 1.2; # Double | longitude (or E depending on request-crs) for request circle center
my $boundaryPeriodcirclePeriodlat = 1.2; # Double | latitude (or N depending on request-crs) for request circle center
my $boundaryPeriodcirclePeriodradius = 1.2; # Double | search radius in meters (default is 1000m, results are sorted nearest first)
my $sources = sources_example; # String | comma separated list of sources (if none given defaults are used)
my $layers = layers_example; # String | (this parameter has no effect in this service)
my $lang = lang_example; # String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
my $exclude = exclude_example; # String | exclusion map for codelist matching - This is a Pelias API extension
my $crs = crs_example; # String | output CRS code for geometries (default 4326) - This is a Pelias API extension
my $requestCrs = requestCrs_example; # String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension
my $scalePerioddenominator = 56; # Integer | used only for mapsheets atm  - This is a Pelias API extension

eval { 
    my $result = $api_instance->decode(text => $text, size => $size, boundaryPeriodrectPeriodminLon => $boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon => $boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat => $boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat => $boundaryPeriodrectPeriodmaxLat, focusPeriodpointPeriodlon => $focusPeriodpointPeriodlon, focusPeriodpointPeriodlat => $focusPeriodpointPeriodlat, boundaryPeriodcirclePeriodlon => $boundaryPeriodcirclePeriodlon, boundaryPeriodcirclePeriodlat => $boundaryPeriodcirclePeriodlat, boundaryPeriodcirclePeriodradius => $boundaryPeriodcirclePeriodradius, sources => $sources, layers => $layers, lang => $lang, exclude => $exclude, crs => $crs, requestCrs => $requestCrs, scalePerioddenominator => $scalePerioddenominator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->decode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()
text = text_example # String | search term (optional) (default to null)
size = 56 # Integer | maximum response feature count (optional) (default to 10)
boundaryPeriodrectPeriodminLon = 1.2 # Double | min longitude (or E depending on request-crs) for request boundary rectangle (optional) (default to null)
boundaryPeriodrectPeriodmaxLon = 1.2 # Double | max longitude (or E depending on request-crs) for request boundary rectangle (optional) (default to null)
boundaryPeriodrectPeriodminLat = 1.2 # Double | min latitude (or N depending on request-crs) for request boundary rectangle (optional) (default to null)
boundaryPeriodrectPeriodmaxLat = 1.2 # Double | max latitude (or N depending on request-crs) for request boundary rectangle (optional) (default to null)
focusPeriodpointPeriodlon = 1.2 # Double | longitude (or E depending on request-crs) for request focus point (optional) (default to null)
focusPeriodpointPeriodlat = 1.2 # Double | latitude (or N depending on request-crs) for request focus point (optional) (default to null)
boundaryPeriodcirclePeriodlon = 1.2 # Double | longitude (or E depending on request-crs) for request circle center (optional) (default to null)
boundaryPeriodcirclePeriodlat = 1.2 # Double | latitude (or N depending on request-crs) for request circle center (optional) (default to null)
boundaryPeriodcirclePeriodradius = 1.2 # Double | search radius in meters (default is 1000m, results are sorted nearest first) (optional) (default to null)
sources = sources_example # String | comma separated list of sources (if none given defaults are used) (optional) (default to null)
layers = layers_example # String | (this parameter has no effect in this service) (optional) (default to null)
lang = lang_example # String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension (optional) (default to fin)
exclude = exclude_example # String | exclusion map for codelist matching - This is a Pelias API extension (optional) (default to null)
crs = crs_example # String | output CRS code for geometries (default 4326) - This is a Pelias API extension (optional) (default to http://www.opengis.net/def/crs/EPSG/0/4326)
requestCrs = requestCrs_example # String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension (optional) (default to http://www.opengis.net/def/crs/EPSG/0/4326)
scalePerioddenominator = 56 # Integer | used only for mapsheets atm  - This is a Pelias API extension (optional) (default to 5000)

try: 
    # decode text and return any codelist values
    api_response = api_instance.decode(text=text, size=size, boundaryPeriodrectPeriodminLon=boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon=boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat=boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat=boundaryPeriodrectPeriodmaxLat, focusPeriodpointPeriodlon=focusPeriodpointPeriodlon, focusPeriodpointPeriodlat=focusPeriodpointPeriodlat, boundaryPeriodcirclePeriodlon=boundaryPeriodcirclePeriodlon, boundaryPeriodcirclePeriodlat=boundaryPeriodcirclePeriodlat, boundaryPeriodcirclePeriodradius=boundaryPeriodcirclePeriodradius, sources=sources, layers=layers, lang=lang, exclude=exclude, crs=crs, requestCrs=requestCrs, scalePerioddenominator=scalePerioddenominator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->decode: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let text = text_example; // String
    let size = 56; // Integer
    let boundaryPeriodrectPeriodminLon = 1.2; // Double
    let boundaryPeriodrectPeriodmaxLon = 1.2; // Double
    let boundaryPeriodrectPeriodminLat = 1.2; // Double
    let boundaryPeriodrectPeriodmaxLat = 1.2; // Double
    let focusPeriodpointPeriodlon = 1.2; // Double
    let focusPeriodpointPeriodlat = 1.2; // Double
    let boundaryPeriodcirclePeriodlon = 1.2; // Double
    let boundaryPeriodcirclePeriodlat = 1.2; // Double
    let boundaryPeriodcirclePeriodradius = 1.2; // Double
    let sources = sources_example; // String
    let layers = layers_example; // String
    let lang = lang_example; // String
    let exclude = exclude_example; // String
    let crs = crs_example; // String
    let requestCrs = requestCrs_example; // String
    let scalePerioddenominator = 56; // Integer

    let mut context = DefaultApi::Context::default();
    let result = client.decode(text, size, boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat, focusPeriodpointPeriodlon, focusPeriodpointPeriodlat, boundaryPeriodcirclePeriodlon, boundaryPeriodcirclePeriodlat, boundaryPeriodcirclePeriodradius, sources, layers, lang, exclude, crs, requestCrs, scalePerioddenominator, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
text
String
search term
size
Integer (int32)
maximum response feature count
boundary.rect.min_lon
Double (double)
min longitude (or E depending on request-crs) for request boundary rectangle
boundary.rect.max_lon
Double (double)
max longitude (or E depending on request-crs) for request boundary rectangle
boundary.rect.min_lat
Double (double)
min latitude (or N depending on request-crs) for request boundary rectangle
boundary.rect.max_lat
Double (double)
max latitude (or N depending on request-crs) for request boundary rectangle
focus.point.lon
Double (double)
longitude (or E depending on request-crs) for request focus point
focus.point.lat
Double (double)
latitude (or N depending on request-crs) for request focus point
boundary.circle.lon
Double (double)
longitude (or E depending on request-crs) for request circle center
boundary.circle.lat
Double (double)
latitude (or N depending on request-crs) for request circle center
boundary.circle.radius
Double (double)
search radius in meters (default is 1000m, results are sorted nearest first)
sources
String
comma separated list of sources (if none given defaults are used)
layers
String
(this parameter has no effect in this service)
lang
String
locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
exclude
String
exclusion map for codelist matching - This is a Pelias API extension
crs
String
output CRS code for geometries (default 4326) - This is a Pelias API extension
request-crs
String
request CRS for request parameters (boundary,focus) - This is a Pelias API extension
scale.denominator
Integer (int32)
used only for mapsheets atm - This is a Pelias API extension

Responses


reverse

geocoding Pelias reverse implementation


/geocoding/v1/pelias/reverse

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/geocoding/v1/pelias/reverse?text=&size=&point.lon=&point.lat=&boundary.circle.radius=&boundary.rect.min_lon=&boundary.rect.max_lon=&boundary.rect.min_lat=&boundary.rect.max_lat=&sources=&layers=&lang=&crs=&request-crs=&exclude=&scale.denominator="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String text = text_example; // String | search term to add to reverse search - This is a Pelias API extension
        Integer size = 56; // Integer | maximum response feature count
        Double pointPeriodlon = 1.2; // Double | longitude (or E depending on request-crs) for reverse search
        Double pointPeriodlat = 1.2; // Double | latitude (or N depending on request-crs) for reverse search
        Double boundaryPeriodcirclePeriodradius = 1.2; // Double | search radius in meters (default is 1000m, results are sorted nearest first)
        Double boundaryPeriodrectPeriodminLon = 1.2; // Double | min longitude (or E depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodmaxLon = 1.2; // Double | max longitude (or E depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodminLat = 1.2; // Double | min latitude (or N depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodmaxLat = 1.2; // Double | max latitude (or N depending on request-crs) for request boundary rectangle
        String sources = sources_example; // String | comma separated list of sources (if none given defaults are used)
        String layers = layers_example; // String | (this parameter has no effect in this service)
        String lang = lang_example; // String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
        String crs = crs_example; // String | output CRS code for geometries (default 4326) - This is a Pelias API extension
        String requestCrs = requestCrs_example; // String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension
        String exclude = exclude_example; // String | exclusion map for codelist matching - This is a Pelias API extension
        Integer scalePerioddenominator = 56; // Integer | used only for mapsheets atm  - This is a Pelias API extension
        try {
            peliasResponseFeatureCollectionGeoJSON result = apiInstance.reverse(text, size, pointPeriodlon, pointPeriodlat, boundaryPeriodcirclePeriodradius, boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat, sources, layers, lang, crs, requestCrs, exclude, scalePerioddenominator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#reverse");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String text = text_example; // String | search term to add to reverse search - This is a Pelias API extension
        Integer size = 56; // Integer | maximum response feature count
        Double pointPeriodlon = 1.2; // Double | longitude (or E depending on request-crs) for reverse search
        Double pointPeriodlat = 1.2; // Double | latitude (or N depending on request-crs) for reverse search
        Double boundaryPeriodcirclePeriodradius = 1.2; // Double | search radius in meters (default is 1000m, results are sorted nearest first)
        Double boundaryPeriodrectPeriodminLon = 1.2; // Double | min longitude (or E depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodmaxLon = 1.2; // Double | max longitude (or E depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodminLat = 1.2; // Double | min latitude (or N depending on request-crs) for request boundary rectangle
        Double boundaryPeriodrectPeriodmaxLat = 1.2; // Double | max latitude (or N depending on request-crs) for request boundary rectangle
        String sources = sources_example; // String | comma separated list of sources (if none given defaults are used)
        String layers = layers_example; // String | (this parameter has no effect in this service)
        String lang = lang_example; // String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
        String crs = crs_example; // String | output CRS code for geometries (default 4326) - This is a Pelias API extension
        String requestCrs = requestCrs_example; // String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension
        String exclude = exclude_example; // String | exclusion map for codelist matching - This is a Pelias API extension
        Integer scalePerioddenominator = 56; // Integer | used only for mapsheets atm  - This is a Pelias API extension
        try {
            peliasResponseFeatureCollectionGeoJSON result = apiInstance.reverse(text, size, pointPeriodlon, pointPeriodlat, boundaryPeriodcirclePeriodradius, boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat, sources, layers, lang, crs, requestCrs, exclude, scalePerioddenominator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#reverse");
            e.printStackTrace();
        }
    }
}
String *text = text_example; // search term to add to reverse search - This is a Pelias API extension (optional) (default to null)
Integer *size = 56; // maximum response feature count (optional) (default to 10)
Double *pointPeriodlon = 1.2; // longitude (or E depending on request-crs) for reverse search (optional) (default to null)
Double *pointPeriodlat = 1.2; // latitude (or N depending on request-crs) for reverse search (optional) (default to null)
Double *boundaryPeriodcirclePeriodradius = 1.2; // search radius in meters (default is 1000m, results are sorted nearest first) (optional) (default to 500)
Double *boundaryPeriodrectPeriodminLon = 1.2; // min longitude (or E depending on request-crs) for request boundary rectangle (optional) (default to null)
Double *boundaryPeriodrectPeriodmaxLon = 1.2; // max longitude (or E depending on request-crs) for request boundary rectangle (optional) (default to null)
Double *boundaryPeriodrectPeriodminLat = 1.2; // min latitude (or N depending on request-crs) for request boundary rectangle (optional) (default to null)
Double *boundaryPeriodrectPeriodmaxLat = 1.2; // max latitude (or N depending on request-crs) for request boundary rectangle (optional) (default to null)
String *sources = sources_example; // comma separated list of sources (if none given defaults are used) (optional) (default to null)
String *layers = layers_example; // (this parameter has no effect in this service) (optional) (default to null)
String *lang = lang_example; // locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension (optional) (default to fin)
String *crs = crs_example; // output CRS code for geometries (default 4326) - This is a Pelias API extension (optional) (default to http://www.opengis.net/def/crs/EPSG/0/4326)
String *requestCrs = requestCrs_example; // request CRS for request parameters (boundary,focus) - This is a Pelias API extension (optional) (default to http://www.opengis.net/def/crs/EPSG/0/4326)
String *exclude = exclude_example; // exclusion map for codelist matching - This is a Pelias API extension (optional) (default to null)
Integer *scalePerioddenominator = 56; // used only for mapsheets atm  - This is a Pelias API extension (optional) (default to 5000)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// geocoding Pelias reverse implementation
[apiInstance reverseWith:text
    size:size
    pointPeriodlon:pointPeriodlon
    pointPeriodlat:pointPeriodlat
    boundaryPeriodcirclePeriodradius:boundaryPeriodcirclePeriodradius
    boundaryPeriodrectPeriodminLon:boundaryPeriodrectPeriodminLon
    boundaryPeriodrectPeriodmaxLon:boundaryPeriodrectPeriodmaxLon
    boundaryPeriodrectPeriodminLat:boundaryPeriodrectPeriodminLat
    boundaryPeriodrectPeriodmaxLat:boundaryPeriodrectPeriodmaxLat
    sources:sources
    layers:layers
    lang:lang
    crs:crs
    requestCrs:requestCrs
    exclude:exclude
    scalePerioddenominator:scalePerioddenominator
              completionHandler: ^(peliasResponseFeatureCollectionGeoJSON output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GeocodingApi = require('geocoding_api');

var api = new GeocodingApi.DefaultApi()
var opts = {
  'text': text_example, // {String} search term to add to reverse search - This is a Pelias API extension
  'size': 56, // {Integer} maximum response feature count
  'pointPeriodlon': 1.2, // {Double} longitude (or E depending on request-crs) for reverse search
  'pointPeriodlat': 1.2, // {Double} latitude (or N depending on request-crs) for reverse search
  'boundaryPeriodcirclePeriodradius': 1.2, // {Double} search radius in meters (default is 1000m, results are sorted nearest first)
  'boundaryPeriodrectPeriodminLon': 1.2, // {Double} min longitude (or E depending on request-crs) for request boundary rectangle
  'boundaryPeriodrectPeriodmaxLon': 1.2, // {Double} max longitude (or E depending on request-crs) for request boundary rectangle
  'boundaryPeriodrectPeriodminLat': 1.2, // {Double} min latitude (or N depending on request-crs) for request boundary rectangle
  'boundaryPeriodrectPeriodmaxLat': 1.2, // {Double} max latitude (or N depending on request-crs) for request boundary rectangle
  'sources': sources_example, // {String} comma separated list of sources (if none given defaults are used)
  'layers': layers_example, // {String} (this parameter has no effect in this service)
  'lang': lang_example, // {String} locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
  'crs': crs_example, // {String} output CRS code for geometries (default 4326) - This is a Pelias API extension
  'requestCrs': requestCrs_example, // {String} request CRS for request parameters (boundary,focus) - This is a Pelias API extension
  'exclude': exclude_example, // {String} exclusion map for codelist matching - This is a Pelias API extension
  'scalePerioddenominator': 56 // {Integer} used only for mapsheets atm  - This is a Pelias API extension
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reverse(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class reverseExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var text = text_example;  // String | search term to add to reverse search - This is a Pelias API extension (optional)  (default to null)
            var size = 56;  // Integer | maximum response feature count (optional)  (default to 10)
            var pointPeriodlon = 1.2;  // Double | longitude (or E depending on request-crs) for reverse search (optional)  (default to null)
            var pointPeriodlat = 1.2;  // Double | latitude (or N depending on request-crs) for reverse search (optional)  (default to null)
            var boundaryPeriodcirclePeriodradius = 1.2;  // Double | search radius in meters (default is 1000m, results are sorted nearest first) (optional)  (default to 500)
            var boundaryPeriodrectPeriodminLon = 1.2;  // Double | min longitude (or E depending on request-crs) for request boundary rectangle (optional)  (default to null)
            var boundaryPeriodrectPeriodmaxLon = 1.2;  // Double | max longitude (or E depending on request-crs) for request boundary rectangle (optional)  (default to null)
            var boundaryPeriodrectPeriodminLat = 1.2;  // Double | min latitude (or N depending on request-crs) for request boundary rectangle (optional)  (default to null)
            var boundaryPeriodrectPeriodmaxLat = 1.2;  // Double | max latitude (or N depending on request-crs) for request boundary rectangle (optional)  (default to null)
            var sources = sources_example;  // String | comma separated list of sources (if none given defaults are used) (optional)  (default to null)
            var layers = layers_example;  // String | (this parameter has no effect in this service) (optional)  (default to null)
            var lang = lang_example;  // String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension (optional)  (default to fin)
            var crs = crs_example;  // String | output CRS code for geometries (default 4326) - This is a Pelias API extension (optional)  (default to http://www.opengis.net/def/crs/EPSG/0/4326)
            var requestCrs = requestCrs_example;  // String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension (optional)  (default to http://www.opengis.net/def/crs/EPSG/0/4326)
            var exclude = exclude_example;  // String | exclusion map for codelist matching - This is a Pelias API extension (optional)  (default to null)
            var scalePerioddenominator = 56;  // Integer | used only for mapsheets atm  - This is a Pelias API extension (optional)  (default to 5000)

            try
            {
                // geocoding Pelias reverse implementation
                peliasResponseFeatureCollectionGeoJSON result = apiInstance.reverse(text, size, pointPeriodlon, pointPeriodlat, boundaryPeriodcirclePeriodradius, boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat, sources, layers, lang, crs, requestCrs, exclude, scalePerioddenominator);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.reverse: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$text = text_example; // String | search term to add to reverse search - This is a Pelias API extension
$size = 56; // Integer | maximum response feature count
$pointPeriodlon = 1.2; // Double | longitude (or E depending on request-crs) for reverse search
$pointPeriodlat = 1.2; // Double | latitude (or N depending on request-crs) for reverse search
$boundaryPeriodcirclePeriodradius = 1.2; // Double | search radius in meters (default is 1000m, results are sorted nearest first)
$boundaryPeriodrectPeriodminLon = 1.2; // Double | min longitude (or E depending on request-crs) for request boundary rectangle
$boundaryPeriodrectPeriodmaxLon = 1.2; // Double | max longitude (or E depending on request-crs) for request boundary rectangle
$boundaryPeriodrectPeriodminLat = 1.2; // Double | min latitude (or N depending on request-crs) for request boundary rectangle
$boundaryPeriodrectPeriodmaxLat = 1.2; // Double | max latitude (or N depending on request-crs) for request boundary rectangle
$sources = sources_example; // String | comma separated list of sources (if none given defaults are used)
$layers = layers_example; // String | (this parameter has no effect in this service)
$lang = lang_example; // String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
$crs = crs_example; // String | output CRS code for geometries (default 4326) - This is a Pelias API extension
$requestCrs = requestCrs_example; // String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension
$exclude = exclude_example; // String | exclusion map for codelist matching - This is a Pelias API extension
$scalePerioddenominator = 56; // Integer | used only for mapsheets atm  - This is a Pelias API extension

try {
    $result = $api_instance->reverse($text, $size, $pointPeriodlon, $pointPeriodlat, $boundaryPeriodcirclePeriodradius, $boundaryPeriodrectPeriodminLon, $boundaryPeriodrectPeriodmaxLon, $boundaryPeriodrectPeriodminLat, $boundaryPeriodrectPeriodmaxLat, $sources, $layers, $lang, $crs, $requestCrs, $exclude, $scalePerioddenominator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->reverse: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $text = text_example; # String | search term to add to reverse search - This is a Pelias API extension
my $size = 56; # Integer | maximum response feature count
my $pointPeriodlon = 1.2; # Double | longitude (or E depending on request-crs) for reverse search
my $pointPeriodlat = 1.2; # Double | latitude (or N depending on request-crs) for reverse search
my $boundaryPeriodcirclePeriodradius = 1.2; # Double | search radius in meters (default is 1000m, results are sorted nearest first)
my $boundaryPeriodrectPeriodminLon = 1.2; # Double | min longitude (or E depending on request-crs) for request boundary rectangle
my $boundaryPeriodrectPeriodmaxLon = 1.2; # Double | max longitude (or E depending on request-crs) for request boundary rectangle
my $boundaryPeriodrectPeriodminLat = 1.2; # Double | min latitude (or N depending on request-crs) for request boundary rectangle
my $boundaryPeriodrectPeriodmaxLat = 1.2; # Double | max latitude (or N depending on request-crs) for request boundary rectangle
my $sources = sources_example; # String | comma separated list of sources (if none given defaults are used)
my $layers = layers_example; # String | (this parameter has no effect in this service)
my $lang = lang_example; # String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
my $crs = crs_example; # String | output CRS code for geometries (default 4326) - This is a Pelias API extension
my $requestCrs = requestCrs_example; # String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension
my $exclude = exclude_example; # String | exclusion map for codelist matching - This is a Pelias API extension
my $scalePerioddenominator = 56; # Integer | used only for mapsheets atm  - This is a Pelias API extension

eval { 
    my $result = $api_instance->reverse(text => $text, size => $size, pointPeriodlon => $pointPeriodlon, pointPeriodlat => $pointPeriodlat, boundaryPeriodcirclePeriodradius => $boundaryPeriodcirclePeriodradius, boundaryPeriodrectPeriodminLon => $boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon => $boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat => $boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat => $boundaryPeriodrectPeriodmaxLat, sources => $sources, layers => $layers, lang => $lang, crs => $crs, requestCrs => $requestCrs, exclude => $exclude, scalePerioddenominator => $scalePerioddenominator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->reverse: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()
text = text_example # String | search term to add to reverse search - This is a Pelias API extension (optional) (default to null)
size = 56 # Integer | maximum response feature count (optional) (default to 10)
pointPeriodlon = 1.2 # Double | longitude (or E depending on request-crs) for reverse search (optional) (default to null)
pointPeriodlat = 1.2 # Double | latitude (or N depending on request-crs) for reverse search (optional) (default to null)
boundaryPeriodcirclePeriodradius = 1.2 # Double | search radius in meters (default is 1000m, results are sorted nearest first) (optional) (default to 500)
boundaryPeriodrectPeriodminLon = 1.2 # Double | min longitude (or E depending on request-crs) for request boundary rectangle (optional) (default to null)
boundaryPeriodrectPeriodmaxLon = 1.2 # Double | max longitude (or E depending on request-crs) for request boundary rectangle (optional) (default to null)
boundaryPeriodrectPeriodminLat = 1.2 # Double | min latitude (or N depending on request-crs) for request boundary rectangle (optional) (default to null)
boundaryPeriodrectPeriodmaxLat = 1.2 # Double | max latitude (or N depending on request-crs) for request boundary rectangle (optional) (default to null)
sources = sources_example # String | comma separated list of sources (if none given defaults are used) (optional) (default to null)
layers = layers_example # String | (this parameter has no effect in this service) (optional) (default to null)
lang = lang_example # String | locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension (optional) (default to fin)
crs = crs_example # String | output CRS code for geometries (default 4326) - This is a Pelias API extension (optional) (default to http://www.opengis.net/def/crs/EPSG/0/4326)
requestCrs = requestCrs_example # String | request CRS for request parameters (boundary,focus) - This is a Pelias API extension (optional) (default to http://www.opengis.net/def/crs/EPSG/0/4326)
exclude = exclude_example # String | exclusion map for codelist matching - This is a Pelias API extension (optional) (default to null)
scalePerioddenominator = 56 # Integer | used only for mapsheets atm  - This is a Pelias API extension (optional) (default to 5000)

try: 
    # geocoding Pelias reverse implementation
    api_response = api_instance.reverse(text=text, size=size, pointPeriodlon=pointPeriodlon, pointPeriodlat=pointPeriodlat, boundaryPeriodcirclePeriodradius=boundaryPeriodcirclePeriodradius, boundaryPeriodrectPeriodminLon=boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon=boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat=boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat=boundaryPeriodrectPeriodmaxLat, sources=sources, layers=layers, lang=lang, crs=crs, requestCrs=requestCrs, exclude=exclude, scalePerioddenominator=scalePerioddenominator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->reverse: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let text = text_example; // String
    let size = 56; // Integer
    let pointPeriodlon = 1.2; // Double
    let pointPeriodlat = 1.2; // Double
    let boundaryPeriodcirclePeriodradius = 1.2; // Double
    let boundaryPeriodrectPeriodminLon = 1.2; // Double
    let boundaryPeriodrectPeriodmaxLon = 1.2; // Double
    let boundaryPeriodrectPeriodminLat = 1.2; // Double
    let boundaryPeriodrectPeriodmaxLat = 1.2; // Double
    let sources = sources_example; // String
    let layers = layers_example; // String
    let lang = lang_example; // String
    let crs = crs_example; // String
    let requestCrs = requestCrs_example; // String
    let exclude = exclude_example; // String
    let scalePerioddenominator = 56; // Integer

    let mut context = DefaultApi::Context::default();
    let result = client.reverse(text, size, pointPeriodlon, pointPeriodlat, boundaryPeriodcirclePeriodradius, boundaryPeriodrectPeriodminLon, boundaryPeriodrectPeriodmaxLon, boundaryPeriodrectPeriodminLat, boundaryPeriodrectPeriodmaxLat, sources, layers, lang, crs, requestCrs, exclude, scalePerioddenominator, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
text
String
search term to add to reverse search - This is a Pelias API extension
size
Integer (int32)
maximum response feature count
point.lon
Double (double)
longitude (or E depending on request-crs) for reverse search
point.lat
Double (double)
latitude (or N depending on request-crs) for reverse search
boundary.circle.radius
Double (double)
search radius in meters (default is 1000m, results are sorted nearest first)
boundary.rect.min_lon
Double (double)
min longitude (or E depending on request-crs) for request boundary rectangle
boundary.rect.max_lon
Double (double)
max longitude (or E depending on request-crs) for request boundary rectangle
boundary.rect.min_lat
Double (double)
min latitude (or N depending on request-crs) for request boundary rectangle
boundary.rect.max_lat
Double (double)
max latitude (or N depending on request-crs) for request boundary rectangle
sources
String
comma separated list of sources (if none given defaults are used)
layers
String
(this parameter has no effect in this service)
lang
String
locale (such as fi,fin,sv,swe,en,eng) for localized properties in JSON response - This is a Pelias API extension
crs
String
output CRS code for geometries (default 4326) - This is a Pelias API extension
request-crs
String
request CRS for request parameters (boundary,focus) - This is a Pelias API extension
exclude
String
exclusion map for codelist matching - This is a Pelias API extension
scale.denominator
Integer (int32)
used only for mapsheets atm - This is a Pelias API extension

Responses



similar

return similar search terms


/geocoding/v1/searchterm/similar

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/geocoding/v1/searchterm/similar?text=&size="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String text = text_example; // String | search term
        Integer size = 56; // Integer | max similar terms to be returned
        try {
            SearchTermResponse result = apiInstance.similar(text, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#similar");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String text = text_example; // String | search term
        Integer size = 56; // Integer | max similar terms to be returned
        try {
            SearchTermResponse result = apiInstance.similar(text, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#similar");
            e.printStackTrace();
        }
    }
}
String *text = text_example; // search term (default to null)
Integer *size = 56; // max similar terms to be returned (optional) (default to 10)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// return similar search terms
[apiInstance similarWith:text
    size:size
              completionHandler: ^(SearchTermResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GeocodingApi = require('geocoding_api');

var api = new GeocodingApi.DefaultApi()
var text = text_example; // {String} search term
var opts = {
  'size': 56 // {Integer} max similar terms to be returned
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.similar(text, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class similarExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var text = text_example;  // String | search term (default to null)
            var size = 56;  // Integer | max similar terms to be returned (optional)  (default to 10)

            try
            {
                // return similar search terms
                SearchTermResponse result = apiInstance.similar(text, size);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.similar: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$text = text_example; // String | search term
$size = 56; // Integer | max similar terms to be returned

try {
    $result = $api_instance->similar($text, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->similar: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $text = text_example; # String | search term
my $size = 56; # Integer | max similar terms to be returned

eval { 
    my $result = $api_instance->similar(text => $text, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->similar: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()
text = text_example # String | search term (default to null)
size = 56 # Integer | max similar terms to be returned (optional) (default to 10)

try: 
    # return similar search terms
    api_response = api_instance.similar(text, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->similar: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let text = text_example; // String
    let size = 56; // Integer

    let mut context = DefaultApi::Context::default();
    let result = client.similar(text, size, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
text*
String
search term
Required
size
Integer (int32)
max similar terms to be returned

Responses