Overview

API for fetching biodiversity related information about the environment

Version information

Version : 1.0.2

URI scheme

Host : localhost
BasePath : /

Tags

  • biodiversity-occurence-controller : Biodiversity Occurence Controller

Paths

findAll

GET /api/biodiversity

Parameters

Type Name Description Schema Default

Query

bufferZoneMeters
optional

Bufferzone added to the position to search for species

integer (int32)

1

Query

latitude
optional

Latitude of the position to search for species

number (double)

Query

limit
optional

Page limit of the results

integer (int32)

10

Query

localName
optional

Enkel resultaten terug krijgen met lokale naam

boolean

"true"

Query

longitude
optional

Longitude of the position to search for species

number (double)

Query

page
optional

Page number of the results, one-based

integer (int32)

1

Responses

HTTP Code Description Schema

200

Success
Headers :
X-Page-Limit (integer (int32)) : The page limit used to fetch the results.
X-Page-Nr (integer (int32)) : The page number used to fetch the results.
X-Page-Total-Results (integer (int64)) : Total number of species matching the given search criteria.

< BiodiversityOccurenceDTO > array

400

Bad request

< APIError > array

500

Internal Server Error

< APIError > array

Produces

  • /

Tags

  • biodiversity-occurence-controller

findOne

GET /api/biodiversity/detail/{id}

Parameters

Type Name Description Schema

Path

id
optional

Unique identifier of the occurence

integer (int64)

Responses

HTTP Code Description Schema

200

Success

BiodiversityOccurenceDTO

400

Bad request

< APIError > array

500

Internal Server Error

< APIError > array

Produces

  • /

Tags

  • biodiversity-occurence-controller

findAll

GET /api/biodiversity/{kingdom}

Parameters

Type Name Description Schema Default

Query

bufferZoneMeters
optional

Bufferzone added to the position to search for species

integer (int32)

1

Query

kingdom
optional

Name of the kingdom

enum (ANIMAL, PLANT)

Query

latitude
optional

Latitude of the position to search for species

number (double)

Query

limit
optional

Page limit of the results

integer (int32)

10

Query

localName
optional

Enkel resultaten terug krijgen met lokale naam

boolean

"true"

Query

longitude
optional

Longitude of the position to search for species

number (double)

Query

page
optional

Page number of the results, one-based

integer (int32)

1

Responses

HTTP Code Description Schema

200

Success
Headers :
X-Page-Limit (integer (int32)) : The page limit used to fetch the results.
X-Page-Nr (integer (int32)) : The page number used to fetch the results.
X-Page-Total-Results (integer (int64)) : Total number of species matching the given search criteria.

< BiodiversityOccurenceDTO > array

400

Bad request

< APIError > array

500

Internal Server Error

< APIError > array

Produces

  • /

Tags

  • biodiversity-occurence-controller

Definitions

APIError

Name Schema

codes
optional

< string > array

message
optional

string

BiodiversityOccurenceDTO

Name Schema

id
optional

integer (int64)

latitude
optional

number (double)

longitude
optional

number (double)

species
optional

SpeciesDTO

SpeciesDTO

Name Schema

family
optional

string

genus
optional

string

imageUrl
optional

string

kingdom
optional

string

phylum
optional

string

scientificName
optional

string

speciesClass
optional

string

speciesOrder
optional

string

subgenus
optional

string

vernacularName
optional

string