Codelist API

Default

getAllCodelistGroups

return list of codelistgroups


/catalogue/v1/codelistgroups/all

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/all?lang="
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 lang = lang_example; // String | 
        try {
            CodeListCollection result = apiInstance.getAllCodelistGroups(lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAllCodelistGroups");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String lang = lang_example; // String | 
        try {
            CodeListCollection result = apiInstance.getAllCodelistGroups(lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAllCodelistGroups");
            e.printStackTrace();
        }
    }
}
String *lang = lang_example; //  (optional) (default to fin)

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

// return list of codelistgroups
[apiInstance getAllCodelistGroupsWith:lang
              completionHandler: ^(CodeListCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var opts = {
  'lang': lang_example // {String} 
};

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

namespace Example
{
    public class getAllCodelistGroupsExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var lang = lang_example;  // String |  (optional)  (default to fin)

            try
            {
                // return list of codelistgroups
                CodeListCollection result = apiInstance.getAllCodelistGroups(lang);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getAllCodelistGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$lang = lang_example; // String | 

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

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $lang = lang_example; # String | 

eval { 
    my $result = $api_instance->getAllCodelistGroups(lang => $lang);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getAllCodelistGroups: $@\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()
lang = lang_example # String |  (optional) (default to fin)

try: 
    # return list of codelistgroups
    api_response = api_instance.get_all_codelist_groups(lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getAllCodelistGroups: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let lang = lang_example; // String

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

}

Scopes

Parameters

Query parameters
Name Description
lang
String

Responses


getAnyCodelistValue

return codelist values matching search term within codelistgroup


/catalogue/v1/codelistgroups/{codelistgroup}/codelists/any

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists/any?q=&lang=&codelist="
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 q = q_example; // String | codelist group name
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String lang = lang_example; // String | output locale for localized values in response
        array[String] codelist = ; // array[String] | codelist names (use comma as separator)
        try {
            CodeListAnyResponse result = apiInstance.getAnyCodelistValue(q, codelistgroup, lang, codelist);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAnyCodelistValue");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String q = q_example; // String | codelist group name
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String lang = lang_example; // String | output locale for localized values in response
        array[String] codelist = ; // array[String] | codelist names (use comma as separator)
        try {
            CodeListAnyResponse result = apiInstance.getAnyCodelistValue(q, codelistgroup, lang, codelist);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAnyCodelistValue");
            e.printStackTrace();
        }
    }
}
String *q = q_example; // codelist group name (default to null)
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)
array[String] *codelist = ; // codelist names (use comma as separator) (optional) (default to null)

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

// return codelist values matching search term within codelistgroup
[apiInstance getAnyCodelistValueWith:q
    codelistgroup:codelistgroup
    lang:lang
    codelist:codelist
              completionHandler: ^(CodeListAnyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var q = q_example; // {String} codelist group name
var codelistgroup = codelistgroup_example; // {String} codelist group name
var opts = {
  'lang': lang_example, // {String} output locale for localized values in response
  'codelist':  // {array[String]} codelist names (use comma as separator)
};

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

namespace Example
{
    public class getAnyCodelistValueExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var q = q_example;  // String | codelist group name (default to null)
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)
            var codelist = new array[String](); // array[String] | codelist names (use comma as separator) (optional)  (default to null)

            try
            {
                // return codelist values matching search term within codelistgroup
                CodeListAnyResponse result = apiInstance.getAnyCodelistValue(q, codelistgroup, lang, codelist);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getAnyCodelistValue: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$q = q_example; // String | codelist group name
$codelistgroup = codelistgroup_example; // String | codelist group name
$lang = lang_example; // String | output locale for localized values in response
$codelist = ; // array[String] | codelist names (use comma as separator)

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

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $q = q_example; # String | codelist group name
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $lang = lang_example; # String | output locale for localized values in response
my $codelist = []; # array[String] | codelist names (use comma as separator)

eval { 
    my $result = $api_instance->getAnyCodelistValue(q => $q, codelistgroup => $codelistgroup, lang => $lang, codelist => $codelist);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getAnyCodelistValue: $@\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()
q = q_example # String | codelist group name (default to null)
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)
codelist =  # array[String] | codelist names (use comma as separator) (optional) (default to null)

try: 
    # return codelist values matching search term within codelistgroup
    api_response = api_instance.get_any_codelist_value(q, codelistgroup, lang=lang, codelist=codelist)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getAnyCodelistValue: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let q = q_example; // String
    let codelistgroup = codelistgroup_example; // String
    let lang = lang_example; // String
    let codelist = ; // array[String]

    let mut context = DefaultApi::Context::default();
    let result = client.getAnyCodelistValue(q, codelistgroup, lang, codelist, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
Query parameters
Name Description
q*
String
codelist group name
Required
lang
String
output locale for localized values in response
codelist
array[String]
codelist names (use comma as separator)

Responses


getCodelistAnyCodelistValue

return codelist values matching search term within given codelistgroup and codelist


/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/any

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/any?q=&lang="
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 q = q_example; // String | codelist group name
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            CodeListAnyResponse result = apiInstance.getCodelistAnyCodelistValue(q, codelistgroup, codelist, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistAnyCodelistValue");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String q = q_example; // String | codelist group name
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            CodeListAnyResponse result = apiInstance.getCodelistAnyCodelistValue(q, codelistgroup, codelist, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistAnyCodelistValue");
            e.printStackTrace();
        }
    }
}
String *q = q_example; // codelist group name (default to null)
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *codelist = codelist_example; // codelist name (use dash (-) as wildcard) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

// return codelist values matching search term within given codelistgroup and codelist
[apiInstance getCodelistAnyCodelistValueWith:q
    codelistgroup:codelistgroup
    codelist:codelist
    lang:lang
              completionHandler: ^(CodeListAnyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var q = q_example; // {String} codelist group name
var codelistgroup = codelistgroup_example; // {String} codelist group name
var codelist = codelist_example; // {String} codelist name (use dash (-) as wildcard)
var opts = {
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistAnyCodelistValueExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var q = q_example;  // String | codelist group name (default to null)
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var codelist = codelist_example;  // String | codelist name (use dash (-) as wildcard) (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                // return codelist values matching search term within given codelistgroup and codelist
                CodeListAnyResponse result = apiInstance.getCodelistAnyCodelistValue(q, codelistgroup, codelist, lang);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistAnyCodelistValue: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$q = q_example; // String | codelist group name
$codelistgroup = codelistgroup_example; // String | codelist group name
$codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
$lang = lang_example; // String | output locale for localized values in response

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

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $q = q_example; # String | codelist group name
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $codelist = codelist_example; # String | codelist name (use dash (-) as wildcard)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    my $result = $api_instance->getCodelistAnyCodelistValue(q => $q, codelistgroup => $codelistgroup, codelist => $codelist, lang => $lang);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistAnyCodelistValue: $@\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()
q = q_example # String | codelist group name (default to null)
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
codelist = codelist_example # String | codelist name (use dash (-) as wildcard) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    # return codelist values matching search term within given codelistgroup and codelist
    api_response = api_instance.get_codelist_any_codelist_value(q, codelistgroup, codelist, lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistAnyCodelistValue: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let q = q_example; // String
    let codelistgroup = codelistgroup_example; // String
    let codelist = codelist_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistAnyCodelistValue(q, codelistgroup, codelist, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
codelist*
String
codelist name (use dash (-) as wildcard)
Required
Query parameters
Name Description
q*
String
codelist group name
Required
lang
String
output locale for localized values in response

Responses


getCodelistValue

return information on specific codelist value


/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/items/{key}

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/items/{key}?semver=&lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String key = key_example; // String | codelist value key
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            CodeListValueResponse result = apiInstance.getCodelistValue(codelistgroup, codelist, key, semver, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValue");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String key = key_example; // String | codelist value key
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            CodeListValueResponse result = apiInstance.getCodelistValue(codelistgroup, codelist, key, semver, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValue");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *codelist = codelist_example; // codelist name (use dash (-) as wildcard) (default to null)
String *key = key_example; // codelist value key (default to null)
String *semver = semver_example; // codelist version (semantic versioning) (optional) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

// return information on specific codelist value
[apiInstance getCodelistValueWith:codelistgroup
    codelist:codelist
    key:key
    semver:semver
    lang:lang
              completionHandler: ^(CodeListValueResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var codelist = codelist_example; // {String} codelist name (use dash (-) as wildcard)
var key = key_example; // {String} codelist value key
var opts = {
  'semver': semver_example, // {String} codelist version (semantic versioning)
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistValueExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var codelist = codelist_example;  // String | codelist name (use dash (-) as wildcard) (default to null)
            var key = key_example;  // String | codelist value key (default to null)
            var semver = semver_example;  // String | codelist version (semantic versioning) (optional)  (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                // return information on specific codelist value
                CodeListValueResponse result = apiInstance.getCodelistValue(codelistgroup, codelist, key, semver, lang);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistValue: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
$key = key_example; // String | codelist value key
$semver = semver_example; // String | codelist version (semantic versioning)
$lang = lang_example; // String | output locale for localized values in response

try {
    $result = $api_instance->getCodelistValue($codelistgroup, $codelist, $key, $semver, $lang);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getCodelistValue: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $codelist = codelist_example; # String | codelist name (use dash (-) as wildcard)
my $key = key_example; # String | codelist value key
my $semver = semver_example; # String | codelist version (semantic versioning)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    my $result = $api_instance->getCodelistValue(codelistgroup => $codelistgroup, codelist => $codelist, key => $key, semver => $semver, lang => $lang);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistValue: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
codelist = codelist_example # String | codelist name (use dash (-) as wildcard) (default to null)
key = key_example # String | codelist value key (default to null)
semver = semver_example # String | codelist version (semantic versioning) (optional) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    # return information on specific codelist value
    api_response = api_instance.get_codelist_value(codelistgroup, codelist, key, semver=semver, lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistValue: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let codelist = codelist_example; // String
    let key = key_example; // String
    let semver = semver_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistValue(codelistgroup, codelist, key, semver, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
codelist*
String
codelist name (use dash (-) as wildcard)
Required
key*
String
codelist value key
Required
Query parameters
Name Description
semver
String
codelist version (semantic versioning)
lang
String
output locale for localized values in response

Responses


getCodelistValues

return all values within codelistgroup and codelist


/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/items

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/items?semver=&lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            CodeListDictionaryResponse result = apiInstance.getCodelistValues(codelistgroup, codelist, semver, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValues");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            CodeListDictionaryResponse result = apiInstance.getCodelistValues(codelistgroup, codelist, semver, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValues");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *codelist = codelist_example; // codelist name (use dash (-) as wildcard) (default to null)
String *semver = semver_example; // codelist version (semantic versioning) (optional) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

// return all values within codelistgroup and codelist
[apiInstance getCodelistValuesWith:codelistgroup
    codelist:codelist
    semver:semver
    lang:lang
              completionHandler: ^(CodeListDictionaryResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var codelist = codelist_example; // {String} codelist name (use dash (-) as wildcard)
var opts = {
  'semver': semver_example, // {String} codelist version (semantic versioning)
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistValuesExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var codelist = codelist_example;  // String | codelist name (use dash (-) as wildcard) (default to null)
            var semver = semver_example;  // String | codelist version (semantic versioning) (optional)  (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                // return all values within codelistgroup and codelist
                CodeListDictionaryResponse result = apiInstance.getCodelistValues(codelistgroup, codelist, semver, lang);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistValues: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
$semver = semver_example; // String | codelist version (semantic versioning)
$lang = lang_example; // String | output locale for localized values in response

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

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $codelist = codelist_example; # String | codelist name (use dash (-) as wildcard)
my $semver = semver_example; # String | codelist version (semantic versioning)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    my $result = $api_instance->getCodelistValues(codelistgroup => $codelistgroup, codelist => $codelist, semver => $semver, lang => $lang);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistValues: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
codelist = codelist_example # String | codelist name (use dash (-) as wildcard) (default to null)
semver = semver_example # String | codelist version (semantic versioning) (optional) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    # return all values within codelistgroup and codelist
    api_response = api_instance.get_codelist_values(codelistgroup, codelist, semver=semver, lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistValues: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let codelist = codelist_example; // String
    let semver = semver_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistValues(codelistgroup, codelist, semver, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
codelist*
String
codelist name (use dash (-) as wildcard)
Required
Query parameters
Name Description
semver
String
codelist version (semantic versioning)
lang
String
output locale for localized values in response

Responses


getCodelistValuesAsHTML


/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/codelist.html

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/codelist.html?semver=&lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistValuesAsHTML(codelistgroup, codelist, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsHTML");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistValuesAsHTML(codelistgroup, codelist, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsHTML");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *codelist = codelist_example; // codelist name (use dash (-) as wildcard) (default to null)
String *semver = semver_example; // codelist version (semantic versioning) (optional) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

[apiInstance getCodelistValuesAsHTMLWith:codelistgroup
    codelist:codelist
    semver:semver
    lang:lang
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var codelist = codelist_example; // {String} codelist name (use dash (-) as wildcard)
var opts = {
  'semver': semver_example, // {String} codelist version (semantic versioning)
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistValuesAsHTMLExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var codelist = codelist_example;  // String | codelist name (use dash (-) as wildcard) (default to null)
            var semver = semver_example;  // String | codelist version (semantic versioning) (optional)  (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                apiInstance.getCodelistValuesAsHTML(codelistgroup, codelist, semver, lang);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistValuesAsHTML: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
$semver = semver_example; // String | codelist version (semantic versioning)
$lang = lang_example; // String | output locale for localized values in response

try {
    $api_instance->getCodelistValuesAsHTML($codelistgroup, $codelist, $semver, $lang);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getCodelistValuesAsHTML: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $codelist = codelist_example; # String | codelist name (use dash (-) as wildcard)
my $semver = semver_example; # String | codelist version (semantic versioning)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    $api_instance->getCodelistValuesAsHTML(codelistgroup => $codelistgroup, codelist => $codelist, semver => $semver, lang => $lang);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistValuesAsHTML: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
codelist = codelist_example # String | codelist name (use dash (-) as wildcard) (default to null)
semver = semver_example # String | codelist version (semantic versioning) (optional) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    api_instance.get_codelist_values_as_html(codelistgroup, codelist, semver=semver, lang=lang)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistValuesAsHTML: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let codelist = codelist_example; // String
    let semver = semver_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistValuesAsHTML(codelistgroup, codelist, semver, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
codelist*
String
codelist name (use dash (-) as wildcard)
Required
Query parameters
Name Description
semver
String
codelist version (semantic versioning)
lang
String
output locale for localized values in response

Responses


getCodelistValuesAsInspireJSON


/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/inspire.json

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/inspire.json?semver=&lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistValuesAsInspireJSON(codelistgroup, codelist, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsInspireJSON");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistValuesAsInspireJSON(codelistgroup, codelist, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsInspireJSON");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *codelist = codelist_example; // codelist name (use dash (-) as wildcard) (default to null)
String *semver = semver_example; // codelist version (semantic versioning) (optional) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

[apiInstance getCodelistValuesAsInspireJSONWith:codelistgroup
    codelist:codelist
    semver:semver
    lang:lang
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var codelist = codelist_example; // {String} codelist name (use dash (-) as wildcard)
var opts = {
  'semver': semver_example, // {String} codelist version (semantic versioning)
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistValuesAsInspireJSONExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var codelist = codelist_example;  // String | codelist name (use dash (-) as wildcard) (default to null)
            var semver = semver_example;  // String | codelist version (semantic versioning) (optional)  (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                apiInstance.getCodelistValuesAsInspireJSON(codelistgroup, codelist, semver, lang);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistValuesAsInspireJSON: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
$semver = semver_example; // String | codelist version (semantic versioning)
$lang = lang_example; // String | output locale for localized values in response

try {
    $api_instance->getCodelistValuesAsInspireJSON($codelistgroup, $codelist, $semver, $lang);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getCodelistValuesAsInspireJSON: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $codelist = codelist_example; # String | codelist name (use dash (-) as wildcard)
my $semver = semver_example; # String | codelist version (semantic versioning)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    $api_instance->getCodelistValuesAsInspireJSON(codelistgroup => $codelistgroup, codelist => $codelist, semver => $semver, lang => $lang);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistValuesAsInspireJSON: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
codelist = codelist_example # String | codelist name (use dash (-) as wildcard) (default to null)
semver = semver_example # String | codelist version (semantic versioning) (optional) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    api_instance.get_codelist_values_as_inspire_json(codelistgroup, codelist, semver=semver, lang=lang)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistValuesAsInspireJSON: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let codelist = codelist_example; // String
    let semver = semver_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistValuesAsInspireJSON(codelistgroup, codelist, semver, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
codelist*
String
codelist name (use dash (-) as wildcard)
Required
Query parameters
Name Description
semver
String
codelist version (semantic versioning)
lang
String
output locale for localized values in response

Responses


getCodelistValuesAsLocaleJson

return all codelist values modeled as locale JSON output


/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/items/i18n.json

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/items/i18n.json?semver=&lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            map['String', 'String'] result = apiInstance.getCodelistValuesAsLocaleJson(codelistgroup, codelist, semver, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsLocaleJson");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            map['String', 'String'] result = apiInstance.getCodelistValuesAsLocaleJson(codelistgroup, codelist, semver, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsLocaleJson");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *codelist = codelist_example; // codelist name (use dash (-) as wildcard) (default to null)
String *semver = semver_example; // codelist version (semantic versioning) (optional) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

// return all codelist values modeled as locale JSON output
[apiInstance getCodelistValuesAsLocaleJsonWith:codelistgroup
    codelist:codelist
    semver:semver
    lang:lang
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var codelist = codelist_example; // {String} codelist name (use dash (-) as wildcard)
var opts = {
  'semver': semver_example, // {String} codelist version (semantic versioning)
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistValuesAsLocaleJsonExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var codelist = codelist_example;  // String | codelist name (use dash (-) as wildcard) (default to null)
            var semver = semver_example;  // String | codelist version (semantic versioning) (optional)  (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                // return all codelist values modeled as locale JSON output
                map['String', 'String'] result = apiInstance.getCodelistValuesAsLocaleJson(codelistgroup, codelist, semver, lang);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistValuesAsLocaleJson: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
$semver = semver_example; // String | codelist version (semantic versioning)
$lang = lang_example; // String | output locale for localized values in response

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

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $codelist = codelist_example; # String | codelist name (use dash (-) as wildcard)
my $semver = semver_example; # String | codelist version (semantic versioning)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    my $result = $api_instance->getCodelistValuesAsLocaleJson(codelistgroup => $codelistgroup, codelist => $codelist, semver => $semver, lang => $lang);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistValuesAsLocaleJson: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
codelist = codelist_example # String | codelist name (use dash (-) as wildcard) (default to null)
semver = semver_example # String | codelist version (semantic versioning) (optional) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    # return all codelist values modeled as locale JSON output
    api_response = api_instance.get_codelist_values_as_locale_json(codelistgroup, codelist, semver=semver, lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistValuesAsLocaleJson: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let codelist = codelist_example; // String
    let semver = semver_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistValuesAsLocaleJson(codelistgroup, codelist, semver, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
codelist*
String
codelist name (use dash (-) as wildcard)
Required
Query parameters
Name Description
semver
String
codelist version (semantic versioning)
lang
String
output locale for localized values in response

Responses


getCodelistValuesAsXSLX


/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/items.xlsx

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/items.xlsx?semver=&lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistValuesAsXSLX(codelistgroup, codelist, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsXSLX");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistValuesAsXSLX(codelistgroup, codelist, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsXSLX");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *codelist = codelist_example; // codelist name (use dash (-) as wildcard) (default to null)
String *semver = semver_example; // codelist version (semantic versioning) (optional) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

[apiInstance getCodelistValuesAsXSLXWith:codelistgroup
    codelist:codelist
    semver:semver
    lang:lang
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var codelist = codelist_example; // {String} codelist name (use dash (-) as wildcard)
var opts = {
  'semver': semver_example, // {String} codelist version (semantic versioning)
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistValuesAsXSLXExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var codelist = codelist_example;  // String | codelist name (use dash (-) as wildcard) (default to null)
            var semver = semver_example;  // String | codelist version (semantic versioning) (optional)  (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                apiInstance.getCodelistValuesAsXSLX(codelistgroup, codelist, semver, lang);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistValuesAsXSLX: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
$semver = semver_example; // String | codelist version (semantic versioning)
$lang = lang_example; // String | output locale for localized values in response

try {
    $api_instance->getCodelistValuesAsXSLX($codelistgroup, $codelist, $semver, $lang);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getCodelistValuesAsXSLX: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $codelist = codelist_example; # String | codelist name (use dash (-) as wildcard)
my $semver = semver_example; # String | codelist version (semantic versioning)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    $api_instance->getCodelistValuesAsXSLX(codelistgroup => $codelistgroup, codelist => $codelist, semver => $semver, lang => $lang);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistValuesAsXSLX: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
codelist = codelist_example # String | codelist name (use dash (-) as wildcard) (default to null)
semver = semver_example # String | codelist version (semantic versioning) (optional) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    api_instance.get_codelist_values_as_xslx(codelistgroup, codelist, semver=semver, lang=lang)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistValuesAsXSLX: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let codelist = codelist_example; // String
    let semver = semver_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistValuesAsXSLX(codelistgroup, codelist, semver, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
codelist*
String
codelist name (use dash (-) as wildcard)
Required
Query parameters
Name Description
semver
String
codelist version (semantic versioning)
lang
String
output locale for localized values in response

Responses


getCodelistValuesAsXsd

return all codelist values modeled as XSD enum


/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/schema.xsd

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists/{codelist}/schema.xsd?semver=&lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            map['String', 'String'] result = apiInstance.getCodelistValuesAsXsd(codelistgroup, codelist, semver, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsXsd");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            map['String', 'String'] result = apiInstance.getCodelistValuesAsXsd(codelistgroup, codelist, semver, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistValuesAsXsd");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *codelist = codelist_example; // codelist name (use dash (-) as wildcard) (default to null)
String *semver = semver_example; // codelist version (semantic versioning) (optional) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

// return all codelist values modeled as XSD enum 
[apiInstance getCodelistValuesAsXsdWith:codelistgroup
    codelist:codelist
    semver:semver
    lang:lang
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var codelist = codelist_example; // {String} codelist name (use dash (-) as wildcard)
var opts = {
  'semver': semver_example, // {String} codelist version (semantic versioning)
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistValuesAsXsdExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var codelist = codelist_example;  // String | codelist name (use dash (-) as wildcard) (default to null)
            var semver = semver_example;  // String | codelist version (semantic versioning) (optional)  (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                // return all codelist values modeled as XSD enum 
                map['String', 'String'] result = apiInstance.getCodelistValuesAsXsd(codelistgroup, codelist, semver, lang);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistValuesAsXsd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$codelist = codelist_example; // String | codelist name (use dash (-) as wildcard)
$semver = semver_example; // String | codelist version (semantic versioning)
$lang = lang_example; // String | output locale for localized values in response

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

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $codelist = codelist_example; # String | codelist name (use dash (-) as wildcard)
my $semver = semver_example; # String | codelist version (semantic versioning)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    my $result = $api_instance->getCodelistValuesAsXsd(codelistgroup => $codelistgroup, codelist => $codelist, semver => $semver, lang => $lang);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistValuesAsXsd: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
codelist = codelist_example # String | codelist name (use dash (-) as wildcard) (default to null)
semver = semver_example # String | codelist version (semantic versioning) (optional) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    # return all codelist values modeled as XSD enum 
    api_response = api_instance.get_codelist_values_as_xsd(codelistgroup, codelist, semver=semver, lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistValuesAsXsd: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let codelist = codelist_example; // String
    let semver = semver_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistValuesAsXsd(codelistgroup, codelist, semver, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
codelist*
String
codelist name (use dash (-) as wildcard)
Required
Query parameters
Name Description
semver
String
codelist version (semantic versioning)
lang
String
output locale for localized values in response

Responses


getCodelists

return list of codelists in group


/catalogue/v1/codelistgroups/{codelistgroup}/codelists

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists?lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String lang = lang_example; // String | output locale for localized values in response
        try {
            CodeListCollection result = apiInstance.getCodelists(codelistgroup, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelists");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String lang = lang_example; // String | output locale for localized values in response
        try {
            CodeListCollection result = apiInstance.getCodelists(codelistgroup, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelists");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

// return list of codelists in group
[apiInstance getCodelistsWith:codelistgroup
    lang:lang
              completionHandler: ^(CodeListCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var opts = {
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistsExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                // return list of codelists in group
                CodeListCollection result = apiInstance.getCodelists(codelistgroup, lang);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelists: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$lang = lang_example; // String | output locale for localized values in response

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

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    my $result = $api_instance->getCodelists(codelistgroup => $codelistgroup, lang => $lang);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelists: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    # return list of codelists in group
    api_response = api_instance.get_codelists(codelistgroup, lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelists: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelists(codelistgroup, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
Query parameters
Name Description
lang
String
output locale for localized values in response

Responses


getCodelistsAsTar

return all codelists as TAR package


/catalogue/v1/codelistgroups/{codelistgroup}/codelists.tar

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists.tar?semver=&lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistsAsTar(codelistgroup, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistsAsTar");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistsAsTar(codelistgroup, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistsAsTar");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *semver = semver_example; // codelist version (semantic versioning) (optional) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

// return all codelists as TAR package
[apiInstance getCodelistsAsTarWith:codelistgroup
    semver:semver
    lang:lang
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var opts = {
  'semver': semver_example, // {String} codelist version (semantic versioning)
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistsAsTarExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var semver = semver_example;  // String | codelist version (semantic versioning) (optional)  (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                // return all codelists as TAR package
                apiInstance.getCodelistsAsTar(codelistgroup, semver, lang);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistsAsTar: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$semver = semver_example; // String | codelist version (semantic versioning)
$lang = lang_example; // String | output locale for localized values in response

try {
    $api_instance->getCodelistsAsTar($codelistgroup, $semver, $lang);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getCodelistsAsTar: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $semver = semver_example; # String | codelist version (semantic versioning)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    $api_instance->getCodelistsAsTar(codelistgroup => $codelistgroup, semver => $semver, lang => $lang);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistsAsTar: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
semver = semver_example # String | codelist version (semantic versioning) (optional) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    # return all codelists as TAR package
    api_instance.get_codelists_as_tar(codelistgroup, semver=semver, lang=lang)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistsAsTar: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let semver = semver_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistsAsTar(codelistgroup, semver, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
Query parameters
Name Description
semver
String
codelist version (semantic versioning)
lang
String
output locale for localized values in response

Responses


getCodelistsAsZip

return all codelists as ZIP package


/catalogue/v1/codelistgroups/{codelistgroup}/codelists.zip

Usage and SDK Samples

curl -X GET "https://beta-paikkatieto.maanmittauslaitos.fi/catalogue/v1/codelistgroups/{codelistgroup}/codelists.zip?semver=&lang="
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 codelistgroup = codelistgroup_example; // String | codelist group name
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistsAsZip(codelistgroup, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistsAsZip");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String codelistgroup = codelistgroup_example; // String | codelist group name
        String semver = semver_example; // String | codelist version (semantic versioning)
        String lang = lang_example; // String | output locale for localized values in response
        try {
            apiInstance.getCodelistsAsZip(codelistgroup, semver, lang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getCodelistsAsZip");
            e.printStackTrace();
        }
    }
}
String *codelistgroup = codelistgroup_example; // codelist group name (default to null)
String *semver = semver_example; // codelist version (semantic versioning) (optional) (default to null)
String *lang = lang_example; // output locale for localized values in response (optional) (default to fin)

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

// return all codelists as ZIP package
[apiInstance getCodelistsAsZipWith:codelistgroup
    semver:semver
    lang:lang
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodelistApi = require('codelist_api');

var api = new CodelistApi.DefaultApi()
var codelistgroup = codelistgroup_example; // {String} codelist group name
var opts = {
  'semver': semver_example, // {String} codelist version (semantic versioning)
  'lang': lang_example // {String} output locale for localized values in response
};

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

namespace Example
{
    public class getCodelistsAsZipExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var codelistgroup = codelistgroup_example;  // String | codelist group name (default to null)
            var semver = semver_example;  // String | codelist version (semantic versioning) (optional)  (default to null)
            var lang = lang_example;  // String | output locale for localized values in response (optional)  (default to fin)

            try
            {
                // return all codelists as ZIP package
                apiInstance.getCodelistsAsZip(codelistgroup, semver, lang);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getCodelistsAsZip: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$codelistgroup = codelistgroup_example; // String | codelist group name
$semver = semver_example; // String | codelist version (semantic versioning)
$lang = lang_example; // String | output locale for localized values in response

try {
    $api_instance->getCodelistsAsZip($codelistgroup, $semver, $lang);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getCodelistsAsZip: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $codelistgroup = codelistgroup_example; # String | codelist group name
my $semver = semver_example; # String | codelist version (semantic versioning)
my $lang = lang_example; # String | output locale for localized values in response

eval { 
    $api_instance->getCodelistsAsZip(codelistgroup => $codelistgroup, semver => $semver, lang => $lang);
};
if ($@) {
    warn "Exception when calling DefaultApi->getCodelistsAsZip: $@\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()
codelistgroup = codelistgroup_example # String | codelist group name (default to null)
semver = semver_example # String | codelist version (semantic versioning) (optional) (default to null)
lang = lang_example # String | output locale for localized values in response (optional) (default to fin)

try: 
    # return all codelists as ZIP package
    api_instance.get_codelists_as_zip(codelistgroup, semver=semver, lang=lang)
except ApiException as e:
    print("Exception when calling DefaultApi->getCodelistsAsZip: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let codelistgroup = codelistgroup_example; // String
    let semver = semver_example; // String
    let lang = lang_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getCodelistsAsZip(codelistgroup, semver, lang, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
codelistgroup*
String
codelist group name
Required
Query parameters
Name Description
semver
String
codelist version (semantic versioning)
lang
String
output locale for localized values in response

Responses