SANDBOX Species Observations - Read

API change history

Taxa_GetProbableTaxa

Gets a list of taxa that's plausible to observe in the given area based on previous observations during the given period.

Try it

Request

Request URL

Request parameters

  • integer

    Format - int32. The parent taxon id

  • integer

    Format - int32. East coordinate in RT90.

  • integer

    Format - int32. North coordinate in RT90.

  • integer

    Format - int32. Area in kilometers from the point XCoord - YCoord.

  • string

    Format - date-time (as date-time in RFC3339). Start date.

  • (optional)
    integer

    Format - int32. Weeks to check for taxa occurrence.

    0 = Week for (default value).

    1 = Week for + previous week + next week.

    2 = Week for + two previous weeks + two next weeks.

  • (optional)
    integer

    Format - int32. Overrides default species names language from my pages. Accepted values: 1 - Scientific, 2 - Swedish, 3 - English.

  • (optional)
    integer

    Format - int32. Sets the number of items to skip before starting to return the first item, 0 is default

  • (optional)
    integer

    Format - int32. Sets the max number of items in the result, 50 is default

  • (optional)
    string

    Sets the field to sort the result by, "SystematicOrder" is default

  • (optional)
    string

    Sets the order to sort the result by, "Ascending" or "Descending", "Ascending" is default

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from ids.artdatabanken.se. Supported grant types: Authorization code.

Request body

Responses

200 OK

OK

Representations

[
  {
    "id": 0,
    "name": "string",
    "scientificName": "string",
    "systematicOrder": 0,
    "type": 0,
    "speciesGroupId": 0,
    "protectionLevelId": 0,
    "includedByTaxonId": 0,
    "sightingYearCount": 0
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "format": "int32",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "scientificName": {
        "type": "string"
      },
      "systematicOrder": {
        "format": "int32",
        "type": "integer"
      },
      "type": {
        "format": "int32",
        "type": "integer"
      },
      "speciesGroupId": {
        "format": "int32",
        "type": "integer"
      },
      "protectionLevelId": {
        "format": "int32",
        "type": "integer"
      },
      "includedByTaxonId": {
        "format": "int32",
        "type": "integer"
      },
      "sightingYearCount": {
        "format": "int32",
        "type": "integer"
      }
    }
  }
}
[
  {
    "id": 0,
    "name": "string",
    "scientificName": "string",
    "systematicOrder": 0,
    "type": 0,
    "speciesGroupId": 0,
    "protectionLevelId": 0,
    "includedByTaxonId": 0,
    "sightingYearCount": 0
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "format": "int32",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "scientificName": {
        "type": "string"
      },
      "systematicOrder": {
        "format": "int32",
        "type": "integer"
      },
      "type": {
        "format": "int32",
        "type": "integer"
      },
      "speciesGroupId": {
        "format": "int32",
        "type": "integer"
      },
      "protectionLevelId": {
        "format": "int32",
        "type": "integer"
      },
      "includedByTaxonId": {
        "format": "int32",
        "type": "integer"
      },
      "sightingYearCount": {
        "format": "int32",
        "type": "integer"
      }
    }
  }
}
<TaxonCheckListArray>
  <id>0</id>
  <name>string</name>
  <scientificName>string</scientificName>
  <systematicOrder>0</systematicOrder>
  <type>0</type>
  <speciesGroupId>0</speciesGroupId>
  <protectionLevelId>0</protectionLevelId>
  <includedByTaxonId>0</includedByTaxonId>
  <sightingYearCount>0</sightingYearCount>
</TaxonCheckListArray>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "format": "int32",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "scientificName": {
        "type": "string"
      },
      "systematicOrder": {
        "format": "int32",
        "type": "integer"
      },
      "type": {
        "format": "int32",
        "type": "integer"
      },
      "speciesGroupId": {
        "format": "int32",
        "type": "integer"
      },
      "protectionLevelId": {
        "format": "int32",
        "type": "integer"
      },
      "includedByTaxonId": {
        "format": "int32",
        "type": "integer"
      },
      "sightingYearCount": {
        "format": "int32",
        "type": "integer"
      }
    }
  }
}
<TaxonCheckListArray>
  <id>0</id>
  <name>string</name>
  <scientificName>string</scientificName>
  <systematicOrder>0</systematicOrder>
  <type>0</type>
  <speciesGroupId>0</speciesGroupId>
  <protectionLevelId>0</protectionLevelId>
  <includedByTaxonId>0</includedByTaxonId>
  <sightingYearCount>0</sightingYearCount>
</TaxonCheckListArray>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "format": "int32",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "scientificName": {
        "type": "string"
      },
      "systematicOrder": {
        "format": "int32",
        "type": "integer"
      },
      "type": {
        "format": "int32",
        "type": "integer"
      },
      "speciesGroupId": {
        "format": "int32",
        "type": "integer"
      },
      "protectionLevelId": {
        "format": "int32",
        "type": "integer"
      },
      "includedByTaxonId": {
        "format": "int32",
        "type": "integer"
      },
      "sightingYearCount": {
        "format": "int32",
        "type": "integer"
      }
    }
  }
}

400 Bad Request

Failure due to client-side problem

Representations

{
  "developerMessages": [
    "string"
  ],
  "statusCode": "OK"
}
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
{
  "developerMessages": [
    "string"
  ],
  "statusCode": "OK"
}
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
<ResponseMessage>
  <developerMessages>string</developerMessages>
  <statusCode>OK</statusCode>
</ResponseMessage>
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
<ResponseMessage>
  <developerMessages>string</developerMessages>
  <statusCode>OK</statusCode>
</ResponseMessage>
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}

500 Internal Server Error

Failure due to server-side problem

Representations

{
  "developerMessages": [
    "string"
  ],
  "statusCode": "OK"
}
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
{
  "developerMessages": [
    "string"
  ],
  "statusCode": "OK"
}
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
<ResponseMessage>
  <developerMessages>string</developerMessages>
  <statusCode>OK</statusCode>
</ResponseMessage>
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
<ResponseMessage>
  <developerMessages>string</developerMessages>
  <statusCode>OK</statusCode>
</ResponseMessage>
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.artdatabanken.se/sandbox-observations-r/v2/taxa/occurrence?parentTaxonId={parentTaxonId}&XCoord={XCoord}&YCoord={YCoord}&range={range}&startDate={startDate}?weeks={integer}&speciesNamesLanguageId={integer}&offset={integer}&limit={integer}&sortField={string}&sortOrder={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"

--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}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            // Request parameters
            queryString["weeks"] = "{integer}";
            queryString["speciesNamesLanguageId"] = "{integer}";
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["sortField"] = "{string}";
            queryString["sortOrder"] = "{string}";
            var uri = "https://api.artdatabanken.se/sandbox-observations-r/v2/taxa/occurrence?parentTaxonId={parentTaxonId}&XCoord={XCoord}&YCoord={YCoord}&range={range}&startDate={startDate}&" + 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/sandbox-observations-r/v2/taxa/occurrence?parentTaxonId={parentTaxonId}&XCoord={XCoord}&YCoord={YCoord}&range={range}&startDate={startDate}");

            builder.setParameter("weeks", "{integer}");
            builder.setParameter("speciesNamesLanguageId", "{integer}");
            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("sortField", "{string}");
            builder.setParameter("sortOrder", "{string}");

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


            // 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
            "weeks": "{integer}",
            "speciesNamesLanguageId": "{integer}",
            "offset": "{integer}",
            "limit": "{integer}",
            "sortField": "{string}",
            "sortOrder": "{string}",
        };
      
        $.ajax({
            url: "https://api.artdatabanken.se/sandbox-observations-r/v2/taxa/occurrence?parentTaxonId={parentTaxonId}&XCoord={XCoord}&YCoord={YCoord}&range={range}&startDate={startDate}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            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/sandbox-observations-r/v2/taxa/occurrence?parentTaxonId={parentTaxonId}&XCoord={XCoord}&YCoord={YCoord}&range={range}&startDate={startDate}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"weeks={integer}",
                         @"speciesNamesLanguageId={integer}",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"sortField={string}",
                         @"sortOrder={string}",
                      ];
    
    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 setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // 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/sandbox-observations-r/v2/taxa/occurrence?parentTaxonId={parentTaxonId}&XCoord={XCoord}&YCoord={YCoord}&range={range}&startDate={startDate}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'weeks' => '{integer}',
    'speciesNamesLanguageId' => '{integer}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'sortField' => '{string}',
    'sortOrder' => '{string}',
);

$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}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
    # Request parameters
    'weeks': '{integer}',
    'speciesNamesLanguageId': '{integer}',
    'offset': '{integer}',
    'limit': '{integer}',
    'sortField': '{string}',
    'sortOrder': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/sandbox-observations-r/v2/taxa/occurrence?parentTaxonId={parentTaxonId}&XCoord={XCoord}&YCoord={YCoord}&range={range}&startDate={startDate}&%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}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'weeks': '{integer}',
    'speciesNamesLanguageId': '{integer}',
    'offset': '{integer}',
    'limit': '{integer}',
    'sortField': '{string}',
    'sortOrder': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/sandbox-observations-r/v2/taxa/occurrence?parentTaxonId={parentTaxonId}&XCoord={XCoord}&YCoord={YCoord}&range={range}&startDate={startDate}&%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/sandbox-observations-r/v2/taxa/occurrence?parentTaxonId={parentTaxonId}&XCoord={XCoord}&YCoord={YCoord}&range={range}&startDate={startDate}')

query = URI.encode_www_form({
    # Request parameters
    'weeks' => '{integer}',
    'speciesNamesLanguageId' => '{integer}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'sortField' => '{string}',
    'sortOrder' => '{string}'
})
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 headers
request['Authorization'] = '{access token}'
# 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