Dyntaxa Taxon Service API

API change history

Taxon_SearchTaxonNames

Search for matching taxon names.

Try it

Förfrågan

Begärans-URL

Begäranparametrar

  • (valfri)
    string

    Search string.

  • (valfri)
    string

    Specify Swedish, Scientific or Both.

  • (valfri)
    string
  • (valfri)
    string
  • (valfri)
    string
  • (valfri)
    integer

    Format - int32.

  • (valfri)
    integer

    Format - int32.

Begärandehuvud

  • string
    Prenumerationsnyckel som ger åtkomst till det här API:et. Hittades i din Profil.

Brödtext i begäran

Svar

200 OK

Success

Återgivningar

[
  {
    "taxonInformation": {
      "taxonId": 0,
      "recommendedSwedishNameId": 0,
      "recommendedSwedishName": "string",
      "recommendedScientificNameId": 0,
      "recommendedScientificName": "string"
    },
    "parentId": 0,
    "secondaryParents": [
      0
    ],
    "sortOrder": 0,
    "status": {
      "id": 0,
      "value": "Accepted",
      "name": "string"
    },
    "statusReason": {
      "id": 0,
      "value": "TaxonObsolete",
      "name": "string"
    },
    "category": {
      "id": 0,
      "value": "Root",
      "name": "string"
    },
    "redlistCategory": "string",
    "nrOfChilds": 0,
    "id": 0,
    "name": "string",
    "nameShort": "string",
    "nameStatus": {
      "id": 0,
      "value": "Deleted",
      "name": "string"
    },
    "nameUsage": {
      "id": 0,
      "value": "Accepted",
      "name": "string"
    },
    "author": "string",
    "nomenclature": "string",
    "isOriginal": true,
    "isRecommended": true,
    "isOkForObservationSystems": true,
    "nameCategory": {
      "id": 0,
      "value": "ScientificName",
      "name": "string"
    }
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "taxonInformation": {
        "type": "object",
        "properties": {
          "taxonId": {
            "type": "integer",
            "format": "int32"
          },
          "recommendedSwedishNameId": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "recommendedSwedishName": {
            "type": "string",
            "nullable": true
          },
          "recommendedScientificNameId": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "recommendedScientificName": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "parentId": {
        "type": "integer",
        "description": "Parent id",
        "format": "int32",
        "nullable": true
      },
      "secondaryParents": {
        "type": "array",
        "items": {
          "type": "integer",
          "format": "int32"
        },
        "description": "Secondary parents",
        "nullable": true
      },
      "sortOrder": {
        "type": "integer",
        "description": "SortOrder",
        "format": "int32"
      },
      "status": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Id",
            "format": "int32",
            "readOnly": true
          },
          "value": {
            "enum": [
              "Accepted",
              "Unaccepted"
            ],
            "type": "string",
            "description": "Enum value"
          },
          "name": {
            "type": "string",
            "description": "Translated name",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "statusReason": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Id",
            "format": "int32",
            "readOnly": true
          },
          "value": {
            "enum": [
              "TaxonObsolete",
              "TaxonUndefined",
              "ReplacedDuplicateFrom",
              "ReplacedDuplicateInto",
              "ReplacedTaxonomicFrom",
              "ReplacedTaxonomicInto",
              "SplitFrom",
              "SplitInto",
              "SeparatedFrom",
              "SeparatedInto",
              "MergedGeneralFrom",
              "MergedGeneralInto",
              "MergedExtendedFrom",
              "MergedExtendedInto"
            ],
            "type": "string",
            "description": "Enum value"
          },
          "name": {
            "type": "string",
            "description": "Translated name",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "category": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Id",
            "format": "int32",
            "readOnly": true
          },
          "value": {
            "enum": [
              "Root",
              "Kingdom",
              "Phylum",
              "Subphylum",
              "Superclass",
              "Class",
              "Subclass",
              "Superorder",
              "Order",
              "Suborder",
              "Superfamily",
              "Family",
              "Subfamily",
              "Tribe",
              "Genus",
              "Subgenus",
              "Section",
              "Species",
              "Subspecies",
              "Variety",
              "Form",
              "Hybrid",
              "Cultivar",
              "Population",
              "Infraclass",
              "Parvclass",
              "CollectiveTaxon",
              "SpeciesComplex",
              "Infraorder",
              "Division",
              "Subdivision",
              "MorphoType",
              "Pseudotaxon",
              "Domain",
              "Subkingdom",
              "Branch",
              "Infrakingdom",
              "Superphylum",
              "Infraphylum",
              "Superdivision",
              "Infradivision",
              "Infrafamily",
              "Supertribe",
              "Subtribe",
              "Infratribe",
              "Subsection",
              "Series",
              "Subseries",
              "SpeciesAggregate",
              "CultivarGroup",
              "Unranked",
              "Realm",
              "Subrealm",
              "Superkingdom",
              "Microphylum",
              "Superlegion",
              "Legion",
              "Sublegion",
              "Infralegion",
              "Supercohort",
              "Cohort",
              "Subcohort",
              "Infracohort",
              "Gigaorder",
              "Magnorder",
              "Grandorder",
              "Mirorder",
              "Nanorder",
              "Hypoorder",
              "Minorder",
              "Parvorder",
              "Megafamily",
              "Grandfamily",
              "SupragenericName",
              "Superseries",
              "InfragenericName",
              "InfraspecificName",
              "Grex",
              "Convariety",
              "InfrasubspecificName",
              "Proles",
              "Natio",
              "Aberration",
              "Morph",
              "Subvariety",
              "Subform",
              "Pathovar",
              "Biovar",
              "Chemovar",
              "Morphovar",
              "Phagovar",
              "Serovar",
              "Chemoform",
              "FormaSpecialis",
              "Strain",
              "Other",
              "Group",
              "Chimaira"
            ],
            "type": "string",
            "description": "Enum value"
          },
          "name": {
            "type": "string",
            "description": "Translated name",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "redlistCategory": {
        "type": "string",
        "description": "Redlist category",
        "nullable": true
      },
      "nrOfChilds": {
        "type": "integer",
        "description": "Nr of children",
        "format": "int32"
      },
      "id": {
        "type": "integer",
        "description": "Id",
        "format": "int32"
      },
      "name": {
        "type": "string",
        "description": "Name",
        "nullable": true
      },
      "nameShort": {
        "type": "string",
        "description": "Name short",
        "nullable": true
      },
      "nameStatus": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Id",
            "format": "int32",
            "readOnly": true
          },
          "value": {
            "enum": [
              "Deleted",
              "Acceptable",
              "Preliminary",
              "Unacceptable",
              "Informal",
              "Suppressed",
              "Undescribed",
              "Unpublished",
              "Conserved",
              "Provisional"
            ],
            "type": "string",
            "description": "Enum value"
          },
          "name": {
            "type": "string",
            "description": "Translated name",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nameUsage": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Id",
            "format": "int32",
            "readOnly": true
          },
          "value": {
            "enum": [
              "Accepted",
              "Synonym",
              "ProParteSynonym",
              "MisappliedAuctName",
              "Ambiguous",
              "PbrNname",
              "SeedSource",
              "IncludedIn",
              "CodeName",
              "AcceptedName",
              "TradeName"
            ],
            "type": "string",
            "description": "Enum value"
          },
          "name": {
            "type": "string",
            "description": "Translated name",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "author": {
        "type": "string",
        "description": "Author",
        "nullable": true
      },
      "nomenclature": {
        "type": "string",
        "description": "Nomenclature",
        "nullable": true
      },
      "isOriginal": {
        "type": "boolean",
        "description": "Is original"
      },
      "isRecommended": {
        "type": "boolean",
        "description": "Is recommended"
      },
      "isOkForObservationSystems": {
        "type": "boolean",
        "description": "Is ok for observation systems"
      },
      "nameCategory": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Id",
            "format": "int32",
            "readOnly": true
          },
          "value": {
            "enum": [
              "ScientificName",
              "SwedishName",
              "EnglishName",
              "DanishName",
              "NorwegianName",
              "FinnishName",
              "IcelandicName",
              "AmericanEnglishName",
              "NnCode",
              "ItisName",
              "ItisNumber",
              "ErmsName",
              "GermanName",
              "OriginalName",
              "FaeroeName",
              "AnamorphName",
              "Guid",
              "Nor",
              "Rubin",
              "NineMk",
              "Smi",
              "Rom",
              "Yid",
              "Swe",
              "Fra",
              "Spa",
              "Ita",
              "TaxonIdOrg",
              "Virus",
              "HybridFormula",
              "Cultivar",
              "OTU",
              "Placeholder",
              "None",
              "Por",
              "Prl",
              "Prt",
              "Ndl",
              "Prd",
              "Stn"
            ],
            "type": "string",
            "description": "Enum value"
          },
          "name": {
            "type": "string",
            "description": "Translated name",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false
  }
}

500 Internal Server Error

Server Error

Kodexempel

@ECHO OFF

curl -v -X GET "https://api.artdatabanken.se/taxonservice/v1/taxa/names?searchString={string}&searchFields=Both&isRecommended=NotSet&isOkForObservationSystems=NotSet&culture=sv_SE&page=1&pageSize=100"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["searchString"] = "{string}";
            queryString["searchFields"] = "Both";
            queryString["isRecommended"] = "NotSet";
            queryString["isOkForObservationSystems"] = "NotSet";
            queryString["culture"] = "sv_SE";
            queryString["page"] = "1";
            queryString["pageSize"] = "100";
            var uri = "https://api.artdatabanken.se/taxonservice/v1/taxa/names?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.artdatabanken.se/taxonservice/v1/taxa/names");

            builder.setParameter("searchString", "{string}");
            builder.setParameter("searchFields", "Both");
            builder.setParameter("isRecommended", "NotSet");
            builder.setParameter("isOkForObservationSystems", "NotSet");
            builder.setParameter("culture", "sv_SE");
            builder.setParameter("page", "1");
            builder.setParameter("pageSize", "100");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "searchString": "{string}",
            "searchFields": "Both",
            "isRecommended": "NotSet",
            "isOkForObservationSystems": "NotSet",
            "culture": "sv_SE",
            "page": "1",
            "pageSize": "100",
        };
      
        $.ajax({
            url: "https://api.artdatabanken.se/taxonservice/v1/taxa/names?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.artdatabanken.se/taxonservice/v1/taxa/names";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"searchString={string}",
                         @"searchFields=Both",
                         @"isRecommended=NotSet",
                         @"isOkForObservationSystems=NotSet",
                         @"culture=sv_SE",
                         @"page=1",
                         @"pageSize=100",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.artdatabanken.se/taxonservice/v1/taxa/names');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'searchString' => '{string}',
    'searchFields' => 'Both',
    'isRecommended' => 'NotSet',
    'isOkForObservationSystems' => 'NotSet',
    'culture' => 'sv_SE',
    'page' => '1',
    'pageSize' => '100',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'searchString': '{string}',
    'searchFields': 'Both',
    'isRecommended': 'NotSet',
    'isOkForObservationSystems': 'NotSet',
    'culture': 'sv_SE',
    'page': '1',
    'pageSize': '100',
})

try:
    conn = httplib.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/taxonservice/v1/taxa/names?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'searchString': '{string}',
    'searchFields': 'Both',
    'isRecommended': 'NotSet',
    'isOkForObservationSystems': 'NotSet',
    'culture': 'sv_SE',
    'page': '1',
    'pageSize': '100',
})

try:
    conn = http.client.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/taxonservice/v1/taxa/names?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.artdatabanken.se/taxonservice/v1/taxa/names')

query = URI.encode_www_form({
    # Request parameters
    'searchString' => '{string}',
    'searchFields' => 'Both',
    'isRecommended' => 'NotSet',
    'isOkForObservationSystems' => 'NotSet',
    'culture' => 'sv_SE',
    'page' => '1',
    'pageSize' => '100'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body