ICES Logo   
Contact      Sitemap     FAQ      Glossary      GroupNet Login     Admin  
Explore US              News and Events                 Marine Data        Publications        Community
 
ICES Data portal Inventory Map Query Web Services  


 
 
 
ICES DATA PORTAL
 

The ICES Data Portal Web Services provide the ability to search and retrieve data from the ICES Data Portal warehouse through a programing interface.

Each part of the web services are provided by a web service Aplication Programme Interface (API), which defines the name, input to, and output from the service for a particular data request.

ICES also provides a Web Service Description Language (WSDL) document that fully describes the ICES Data Portal Web Service.
This document can be used to create clients that access the service.

The following web service APIs are provided:
 Name   getICESDataPortalData()
 
Description This API of the webservice returns the data in the same format as the files that come with the download.
 
Input The user can input:
Year: This is a mandatory field and if not given then it will assume that the user wants the current year
Dataset code: List of datasets
Data type code: List of datatypes
Parameter code: List of parameters
Parameter group code: List of parameter groups
Taxonomic code: List of species (user can also input the code of other taxonomic category)
Matrix code: List of matrices
Area code: List of areas
minLatitude:: the minimum latitude for the coordinates of the sample.
maxLatitude:: the maximum latitude for the coordinates of the sample.
minLongitude:: the minimum longitude for the coordinates of the sample.
maxLongitude:: the maximum longitude for the coordinates of the sample.
 
Output Returns the following fields: Year, Month, day, Cruise, Station, Datetime, Longitude, Latitude, Depth, DataSet, Datatype, Parameter, Value, Precision, Unit, Species, Matrix, DEPHL, DEPHU, QFLAG, BASIS, Depth Class, Age Class, Length Class, sex, DayNight, NOINP, Original Value, Original Unit, SampleID, MeasurementID, ICES Position Note, ICES DateTime Note.
 
Example Example to get the ICES data for Mercury in the year of 1991 Example to get the ICES data for Cod in the year of 2008 Example to get the ICES data for Flat fish in Trawl survey in the year of 2004 Example to get the ICES data for Eggs and Larvae, parameter abundance in the year of 2007
 
 
       
 Name  selectOBISSummaryData()
 
Description This API of the webservice returns the datatable of the matches found.
 
Input All input is optional. The input can be one of the these three strings.
LastUpdate (Datetime:"yyyy/mm/dd hh:ss") and/or Year and Predator (scientific name).
If there are no matches, an empty result set will be returned.
 
Output Returns the summary, number of stomachs found in the data base per country per year per species.
 
Example Example to get the summary of the OBIS data for the year of 1991
Example to get the summary of the OBIS data for the species Lophius piscatorius
Example to get the summary of the OBIS data for the year of 1995 and for the species Gadus morhua updated after 2009-03-15 11:00
 
 
 Name  selectOBISData()
 
Description This API of the webservice returns the datatable of the matches found.
 
Input All input is optional. The input can be one or the these three strings.
LastUpdate (Datetime:"yyyy/mm/dd hh:ss") and/or Year and Predator (scientific name).
If there are no matches, an empty result set will be returned.
Output Returns the records found in the data base per country per year per species.
 
Example Example to get the summary of the OBIS data for the year of 1991 and for the species Sardina pilchardus
Example to get the summary of the OBIS data for the year of 2007 and for the species Alosa agone
Example to get the summary of the OBIS data for the year of 1995 and for the species Echiichthys vipera updated after 1995-07-29 18:00
 
 
 Name  intersectPointWithAreas()
 
Description This API of the webservice returns a description of an OSPAR Region if the point is contained within any of the OSPAR Regions/ ICES Areas/ Helcom Sub Basins.
 
Input The latitude and longitude of the point in decimal degrees.
 
Output Returns the name, code and description of the region/area/sub-basin.
 
Example Example of point in a ICES Area/OSPAR Region
Example of point in a ICES Area/HELCOM Sub basin
 
 
 Name  getListDatasets()
 
Description This API of the webservice returns a summary of the datasets found in ICES Data Portal.
 
Input No input is required.
 
Output Returns the name, key, number of measurements, number of years with measurements, date of the first and last measurement for each dataset in ICES Data Portal.
 
Example Example to get the list of datasets
 
 
 Name  getListDatatypes()
 
Description This API of the webservice returns a summary of the datatypes found in ICES Data Portal
 
Input No input is required.
 
Output Returns the name, key, number of measurements, number of years with measurements, date of the first and last measurement for each datatype in ICES Data Portal.
 
Example Example to get the list of datatypes
 
 
 Name   getListMatrices()
 
Description This API of the webservice returns a summary of the matrices found in ICES Data Portal.
 
Input No input is required.
 
Output Returns the name, key, number of measurements, number of years with measurements, date of the first and last measurement for each matrix in ICES Data Portal.
 
Example Example to get the list of matrices
 
 
 Name   getListParameters()
 
Description This API of the webservice returns a summary of the parameters found in ICES Data Portal.
 
Input No input is required.
 
Output Returns the name, key, number of measurements, number of years with measurements, date of the first and last measurement for each parameter in ICES Data Portal.
 
Example Example to get the list of parameters
 
 
 Name   getListParamGroup()
 
Description This API of the webservice returns a summary of the parameter groups found in ICES Data Portal.
 
Input No input is required.
 
Output Returns the name, key, number of mesurements, number of years with measurements, date of the first and last measurement for each parameter group in ICES Data Portal.
 
Example Example to get the list parameter groups
 
 
 Name   getListDataSpecies()
 
Description This API of the webservice returns a summary of the species found in ICES Data Portal.
 
Input No input is required.
 
Output Returns the name, key, number of mesurements, number of years with measurements, date of the first and last measurement for each species in ICES Data Portal.
 
Example Example to get the list of species
 
 


International Council for the Exploration of the Sea (ICES) · Conseil International pour l'Exploration de la Mer (CIEM)
ICES Secretariat · H. C. Andersens Boulevard 44-46, DK 1553, Copenhagen Denmark · Tel: +45 3338 6700 · Fax: +45 3393 4215 · info@ices.dk
Disclaimer © ICES - All Rights Reserved