Endpoints

Updated: 28-6-2023

Description

Provides a list of endpoints

Endpoint

/v2/observation/endpoints

Method

GET

Parameters

None

Response (successful)

HTTP Code: 200

JSON-structure, containing the following elements:

  • endpoints
    • documentation
      • url
    • endpoints
      • url
    • identify
      • url
    • identify_with_token
      • url
    • taxa
      • url
    • taxa_with_filter
      • url
JSON field data-type values description
endpoints.documentation.url string valid URL points to the endpoint for documentation
endpoints.endpoints.url string valid URL points to the endpoint for the endpoints
endpoints.identify.url string valid URL points to the endpoint for public species identification
endpoints.identify_with_token.url string valid URL points to the endpoint for species identification with a token
endpoints.taxa.url string valid URL points to the endpoint for retrieving the taxa
endpoints.taxa_with_filter.url string valid URL points to the endpoint for retrieving the taxa based on a filter

Example request

​
curl \
    "https://multi-source.identify.biodiversityanalysis.eu/v2/observation/endpoints" | \
jq

Requires curl and jq to be installed.

import json

import requests


def example_request():
    url = (
        "https://multi-source.identify."
        "biodiversityanalysis.eu/v2/"
        "observation/endpoints"
    )

    response = requests.get(url=url)
    return response.json()


if __name__ == "__main__":
    json_response = example_request()
    print(json.dumps(json_response, indent=2))

Requires the Python requests library. Available with pip install requests.

Example response

{
  "endpoints": {
    "documentation": {
      "url": "/v2/observation/documentation/"
    },
    "endpoints": {
      "url": "/v2/observation/endpoints/"
    },
    "identify": {
      "url": "/v2/observation/identify/"
    },
    "identify_with_token": {
      "url": "/v2/observation/identify/token/{token}"
    },
    "taxa": {
      "url": "/v2/observation/taxa/main"
    },
    "taxa_with_filter": {
      "url": "/v2/observation/taxa/main?id={taxon_id}"
    }
  }
}