Species Observation System API

API change history

Species Observation System API V1.5. The Species Observation System GitHub repository contains source code and documentation.

Vocabularies_GetVocabularyById

Get a specific vocabulary.

Try it

Förfrågan

Begärans-URL

Begäranparametrar

  • string

Begärandehuvud

  • (valfri)
    string

    The requested API version

  • (valfri)
    string

    Name of system doing the request

  • string
    Prenumerationsnyckel som ger åtkomst till det här API:et. Hittades i din Profil.
  • string
    OAuth 2.0-åtkomsttoken har erhållits från ids.artdatabanken.se. Beviljandetyper som stöds: Authorization code.

Brödtext i begäran

Svar

200 OK

Success

Återgivningar

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32"
    },
    "enumId": {
      "enum": [
        "Sex",
        "Activity",
        "LifeStage",
        "Biotope",
        "Substrate",
        "VerificationStatus",
        "Institution",
        "Unit",
        "BasisOfRecord",
        "Continent",
        "EstablishmentMeans",
        "OccurrenceStatus",
        "AccessRights",
        "Country",
        "Type",
        "AreaType",
        "DiscoveryMethod",
        "DeterminationMethod",
        "ReproductiveCondition",
        "Behavior",
        "SensitivityCategory",
        "BirdNestActivity",
        "ValidationStatus",
        "TaxonProtectionLevel",
        "TaxonCategory"
      ],
      "type": "string"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "localized": {
      "type": "boolean"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "value": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "localized": {
            "type": "boolean"
          },
          "category": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int32"
              },
              "name": {
                "type": "string",
                "nullable": true
              },
              "description": {
                "type": "string",
                "nullable": true
              },
              "localized": {
                "type": "boolean"
              },
              "translations": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "cultureCode": {
                      "type": "string",
                      "description": "Culture code. I.e. en-GB, sv-SE",
                      "nullable": true
                    },
                    "value": {
                      "type": "string",
                      "description": "Translation",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                },
                "description": "Translations.",
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "translations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "cultureCode": {
                  "type": "string",
                  "description": "Culture code. I.e. en-GB, sv-SE",
                  "nullable": true
                },
                "value": {
                  "type": "string",
                  "description": "Translation",
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "description": "Translations.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "externalSystemsMapping": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "enum": [
              "Artportalen",
              "DarwinCore",
              "SwedishSpeciesObservationService"
            ],
            "type": "string"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "mappings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string",
                  "description": "The key in the external system.",
                  "nullable": true
                },
                "description": {
                  "type": "string",
                  "nullable": true
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "description": "Value in data provider.",
                        "nullable": true
                      },
                      "sosId": {
                        "type": "integer",
                        "description": "Id in SOS (Species Observation System).",
                        "format": "int32"
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "id": 0,
  "enumId": "Sex",
  "name": "string",
  "description": "string",
  "localized": true,
  "values": [
    {
      "id": 0,
      "value": "string",
      "description": "string",
      "localized": true,
      "category": {
        "id": 0,
        "name": "string",
        "description": "string",
        "localized": true,
        "translations": [
          {
            "cultureCode": "string",
            "value": "string"
          }
        ]
      },
      "translations": [
        {
          "cultureCode": "string",
          "value": "string"
        }
      ]
    }
  ],
  "externalSystemsMapping": [
    {
      "id": "Artportalen",
      "name": "string",
      "description": "string",
      "mappings": [
        {
          "key": "string",
          "description": "string",
          "values": [
            {
              "value": {},
              "sosId": 0
            }
          ]
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32"
    },
    "enumId": {
      "enum": [
        "Sex",
        "Activity",
        "LifeStage",
        "Biotope",
        "Substrate",
        "VerificationStatus",
        "Institution",
        "Unit",
        "BasisOfRecord",
        "Continent",
        "EstablishmentMeans",
        "OccurrenceStatus",
        "AccessRights",
        "Country",
        "Type",
        "AreaType",
        "DiscoveryMethod",
        "DeterminationMethod",
        "ReproductiveCondition",
        "Behavior",
        "SensitivityCategory",
        "BirdNestActivity",
        "ValidationStatus",
        "TaxonProtectionLevel",
        "TaxonCategory"
      ],
      "type": "string"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "localized": {
      "type": "boolean"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "value": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "localized": {
            "type": "boolean"
          },
          "category": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int32"
              },
              "name": {
                "type": "string",
                "nullable": true
              },
              "description": {
                "type": "string",
                "nullable": true
              },
              "localized": {
                "type": "boolean"
              },
              "translations": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "cultureCode": {
                      "type": "string",
                      "description": "Culture code. I.e. en-GB, sv-SE",
                      "nullable": true
                    },
                    "value": {
                      "type": "string",
                      "description": "Translation",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                },
                "description": "Translations.",
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "translations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "cultureCode": {
                  "type": "string",
                  "description": "Culture code. I.e. en-GB, sv-SE",
                  "nullable": true
                },
                "value": {
                  "type": "string",
                  "description": "Translation",
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "description": "Translations.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "externalSystemsMapping": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "enum": [
              "Artportalen",
              "DarwinCore",
              "SwedishSpeciesObservationService"
            ],
            "type": "string"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "mappings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string",
                  "description": "The key in the external system.",
                  "nullable": true
                },
                "description": {
                  "type": "string",
                  "nullable": true
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "description": "Value in data provider.",
                        "nullable": true
                      },
                      "sosId": {
                        "type": "integer",
                        "description": "Id in SOS (Species Observation System).",
                        "format": "int32"
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "id": 0,
  "enumId": "Sex",
  "name": "string",
  "description": "string",
  "localized": true,
  "values": [
    {
      "id": 0,
      "value": "string",
      "description": "string",
      "localized": true,
      "category": {
        "id": 0,
        "name": "string",
        "description": "string",
        "localized": true,
        "translations": [
          {
            "cultureCode": "string",
            "value": "string"
          }
        ]
      },
      "translations": [
        {
          "cultureCode": "string",
          "value": "string"
        }
      ]
    }
  ],
  "externalSystemsMapping": [
    {
      "id": "Artportalen",
      "name": "string",
      "description": "string",
      "mappings": [
        {
          "key": "string",
          "description": "string",
          "values": [
            {
              "value": {},
              "sosId": 0
            }
          ]
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32"
    },
    "enumId": {
      "enum": [
        "Sex",
        "Activity",
        "LifeStage",
        "Biotope",
        "Substrate",
        "VerificationStatus",
        "Institution",
        "Unit",
        "BasisOfRecord",
        "Continent",
        "EstablishmentMeans",
        "OccurrenceStatus",
        "AccessRights",
        "Country",
        "Type",
        "AreaType",
        "DiscoveryMethod",
        "DeterminationMethod",
        "ReproductiveCondition",
        "Behavior",
        "SensitivityCategory",
        "BirdNestActivity",
        "ValidationStatus",
        "TaxonProtectionLevel",
        "TaxonCategory"
      ],
      "type": "string"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "localized": {
      "type": "boolean"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "value": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "localized": {
            "type": "boolean"
          },
          "category": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int32"
              },
              "name": {
                "type": "string",
                "nullable": true
              },
              "description": {
                "type": "string",
                "nullable": true
              },
              "localized": {
                "type": "boolean"
              },
              "translations": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "cultureCode": {
                      "type": "string",
                      "description": "Culture code. I.e. en-GB, sv-SE",
                      "nullable": true
                    },
                    "value": {
                      "type": "string",
                      "description": "Translation",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                },
                "description": "Translations.",
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "translations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "cultureCode": {
                  "type": "string",
                  "description": "Culture code. I.e. en-GB, sv-SE",
                  "nullable": true
                },
                "value": {
                  "type": "string",
                  "description": "Translation",
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "description": "Translations.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "externalSystemsMapping": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "enum": [
              "Artportalen",
              "DarwinCore",
              "SwedishSpeciesObservationService"
            ],
            "type": "string"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "mappings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string",
                  "description": "The key in the external system.",
                  "nullable": true
                },
                "description": {
                  "type": "string",
                  "nullable": true
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "description": "Value in data provider.",
                        "nullable": true
                      },
                      "sosId": {
                        "type": "integer",
                        "description": "Id in SOS (Species Observation System).",
                        "format": "int32"
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

204 No Content

No Content

500 Internal Server Error

Server Error

Kodexempel

@ECHO OFF

curl -v -X GET "https://api.artdatabanken.se/species-observation-system/v1/Vocabularies/{vocabularyId}"
-H "X-Api-Version: 1.5"
-H "X-Requesting-System: "
-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("X-Api-Version", "1.5");
            client.DefaultRequestHeaders.Add("X-Requesting-System", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            var uri = "https://api.artdatabanken.se/species-observation-system/v1/Vocabularies/{vocabularyId}?" + 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/species-observation-system/v1/Vocabularies/{vocabularyId}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("X-Api-Version", "1.5");
            request.setHeader("X-Requesting-System", "");
            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
        };
      
        $.ajax({
            url: "https://api.artdatabanken.se/species-observation-system/v1/Vocabularies/{vocabularyId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("X-Api-Version","1.5");
                xhrObj.setRequestHeader("X-Requesting-System","");
                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/species-observation-system/v1/Vocabularies/{vocabularyId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"1.5" forHTTPHeaderField:@"X-Api-Version"];
    [_request setValue:@"" forHTTPHeaderField:@"X-Requesting-System"];
    [_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/species-observation-system/v1/Vocabularies/{vocabularyId}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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
    'X-Api-Version': '1.5',
    'X-Requesting-System': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/species-observation-system/v1/Vocabularies/{vocabularyId}?%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
    'X-Api-Version': '1.5',
    'X-Requesting-System': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/species-observation-system/v1/Vocabularies/{vocabularyId}?%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/species-observation-system/v1/Vocabularies/{vocabularyId}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['X-Api-Version'] = '1.5'
# Request headers
request['X-Requesting-System'] = ''
# 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