Eggs and Larvae database
The Eggs and Larvae data portal web services provide the ability to search and retrieve data from database by providing access to the data.
Each part of the web services is provided by a web service API, which defines the name, input to, and output from the service for a particular request.
This page lists all the Eggs and Larvae web service APIs with a description that includes the information provided by the API, the input needed to get data from the API, and the data that is returned by the API.
The following web service APIs are provided:
|
Name
|
getEggsAndLarvaeDataSummary
|
| Description |
Returns the summary, number of eggs found in the data base per stage, survey, year, month and species.
All input is optional. The input can be one or the these five strings.
Month and/or Year and/or Species and/or Survey and/or Stage .
If there are no matches, an empty result set will be returned.
|
| Example |
Example to get the summary for the year of 1991
|
| |
|
Name
|
getEggsAndLarvaeData
|
| Description |
This endpoint allows users to download data based on specified filters such as year, month, survey, stage, species, country, and institute.
The endpoint supports large file downloads (up to 10GB) and is designed for bulk data retrieval.
The downloaded data is provided as a ZIP file, which also includes a disclaimer with acknowledgments and citation requirements.
Request Limits
- Request Size Limit: 10GB
- Multipart Body Length Limit: 10GB
Parameters
The following query parameters are optional:
| Parameter |
Type |
Description |
Example |
Year |
string |
The year of the data to download. |
2023 |
Month |
string |
The month of the data to download. |
05 |
Survey |
string |
The name or ID of the survey. |
I4189 |
Stage |
string |
The stage of the data collection process. |
LV |
Species |
string |
The species for which data is requested. |
Clupea harengus |
Country |
string |
The country where the data was collected. |
DE |
Institute |
string |
The institute responsible for the data. |
1570 |
|
| Example |
Example to get the data for the year of 1956 |
| |
|
Name
|
getEggsAndLarvaeDataEH
|
| Description |
This endpoint retrieves eggs and larvae haull metadata from the database based on the specified filters.
It returns a list of records matching the provided criteria, such as year range, month, survey, ship, gear, and haul IDs.
Parameters
The following query parameters are required:
| Parameter |
Type |
Description |
Example |
YearBegining |
int |
The starting year for the data query. |
2020 |
YearEnd |
int |
The ending year for the data query. |
2023 |
Month |
int |
The month for the data query. |
5 |
Survey |
string |
The code of the survey. |
I4189 |
Ship |
string |
The code of the ship. |
06W2 |
Gear |
string |
The type of gear used during the survey. |
NACKTHAI |
tblHaulID |
int |
The internal database ID of the haul. |
27238914 |
HaulID |
string |
The unique identifier for the haul. |
DE19921006 |
NationalHaulID |
string |
The national identifier for the haul. |
DK-HL-2023-05-001 |
|
| Example |
Example to get the data from 2018 and gear NACKTHAI |
| |
|
Name
|
getEggsAndLarvaeDataEM
|
| Description |
This endpoint retrieves eggs and larvae data from the database based on the specified filters.
It returns a list of records matching the provided criteria, such as year range, month, survey, ship, gear, and haul IDs.
Parameters
The following query parameters are required:
| Parameter |
Type |
Description |
Example |
YearBegining |
int |
The starting year for the data query. |
2020 |
YearEnd |
int |
The ending year for the data query. |
2023 |
Month |
int |
The month for the data query. |
5 |
Survey |
string |
The code of the survey. |
I4189 |
Ship |
string |
The code of the ship. |
06W2 |
Gear |
string |
The type of gear used during the survey. |
NACKTHAI |
tblHaulID |
int |
The internal database ID of the haul. |
27238914 |
HaulID |
string |
The unique identifier for the haul. |
DE19921006 |
NationalHaulID |
string |
The national identifier for the haul. |
DK-HL-2023-05-001 |
|
| Example |
Example to get the data from 2022 |
| |