Dyntaxa Taxon Service API

API change history

Taxon_GetTaxa

Gets all taxon information for a specific set of taxon ids.

Try it

Förfrågan

Begärans-URL

Begäranparametrar

  • (valfri)
    string

    Specify sv_SE for swedish or en_GB for english.

Begärandehuvud

  • (valfri)
    string
    Medietyp i texten som skickas till API:et.
  • string
    Prenumerationsnyckel som ger åtkomst till det här API:et. Hittades i din Profil.

Brödtext i begäran

Taxon id list.

{
  "taxonIds": [
    0
  ]
}
{
  "type": "object",
  "properties": {
    "taxonIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "taxonIds": [
    0
  ]
}
{
  "type": "object",
  "properties": {
    "taxonIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "taxonIds": [
    0
  ]
}
{
  "type": "object",
  "properties": {
    "taxonIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "taxonIds": [
    0
  ]
}
{
  "type": "object",
  "properties": {
    "taxonIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Svar

200 OK

Success

Återgivningar

{
  "taxonId": 0,
  "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,
  "names": [
    {
      "id": 0,
      "name": "string",
      "nameShort": "string",
      "author": "string",
      "category": {
        "id": 0,
        "value": "ScientificName",
        "name": "string"
      },
      "nomenclature": "string",
      "isOriginal": true,
      "isRecommended": true,
      "isOkForObservationSystems": true,
      "status": {
        "id": 0,
        "value": "Deleted",
        "name": "string"
      },
      "usage": {
        "id": 0,
        "value": "Accepted",
        "name": "string"
      }
    }
  ]
}
{
  "type": "object",
  "properties": {
    "taxonId": {
      "type": "integer",
      "description": "Taxon id",
      "format": "int32"
    },
    "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"
    },
    "names": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "nameShort": {
            "type": "string",
            "nullable": true
          },
          "author": {
            "type": "string",
            "nullable": true
          },
          "category": {
            "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
          },
          "nomenclature": {
            "type": "string",
            "nullable": true
          },
          "isOriginal": {
            "type": "boolean"
          },
          "isRecommended": {
            "type": "boolean"
          },
          "isOkForObservationSystems": {
            "type": "boolean"
          },
          "status": {
            "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
          },
          "usage": {
            "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
          }
        },
        "additionalProperties": false
      },
      "description": "Names",
      "nullable": true
    }
  },
  "additionalProperties": false
}

500 Internal Server Error

Server Error

Kodexempel

@ECHO OFF

curl -v -X POST "https://api.artdatabanken.se/taxonservice/v1/taxa?culture=sv_SE"
-H "Content-Type: application/json-patch+json"
-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["culture"] = "sv_SE";
            var uri = "https://api.artdatabanken.se/taxonservice/v1/taxa?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // 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");

            builder.setParameter("culture", "sv_SE");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            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
            "culture": "sv_SE",
        };
      
        $.ajax({
            url: "https://api.artdatabanken.se/taxonservice/v1/taxa?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"culture=sv_SE",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_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');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'culture' => 'sv_SE',
);

$url->setQueryVariables($parameters);

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

// 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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'culture': 'sv_SE',
})

try:
    conn = httplib.HTTPSConnection('api.artdatabanken.se')
    conn.request("POST", "/taxonservice/v1/taxa?%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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'culture': 'sv_SE',
})

try:
    conn = http.client.HTTPSConnection('api.artdatabanken.se')
    conn.request("POST", "/taxonservice/v1/taxa?%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')

query = URI.encode_www_form({
    # Request parameters
    'culture' => 'sv_SE'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# 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