European Seabirds At Sea (ESAS)



This page lists all web services of European Seabirds At Sea (ESAS). For each API endpoint the description and input parameters are provided, as well as some examples. For less technical access to the data, see the download page.


The following web service APIs are provided:


Name getFileSubmissions
Description Returns file submissions (i.e. how data were submitted to ESAS for each campaign). Parameters:
  • DataRightsHolder
  • Country
Example Get all file submissions
 
Name getCampaignRecords/{offset}/{limit}
Description Returns campaign information.
Parameters:
  • DataRightsHolder
  • Country
  • CampaignID
  • DataAccess
  • Year, multiple allowed: year=2012,2013,2014
Example Get first 1000 campaigns from Denmark
 
Name getSampleRecords/{offset}/{limit}
Description Returns sample information. Users authenticated with a JWT token will also have access to restricted data associated with their organization.
Parameters:
  • CampaignID
  • SampleID
  • Year, multiple allowed: year=2012,2013,2014
  • PlatformCode
  • PlatformClass
  • PrimarySampling, as boolean: primarySampling=true
Example Get first 100 public samples from 2012,2015,2017
 
Name getPositionRecords/{offset}/{limit}
Description Returns position information. Users authenticated with a JWT token will also have access to restricted data associated with their organization.
Parameters:
  • CampaignID
  • SampleID
  • PositionID
  • Latitude, as a range query: latitude=51,53
  • Longitude, as a range query: longitude=51,53
Example Get first 20 public positions from latitudes 49.7 to 53.2
 
Name getObservationRecords/{offset}/{limit}
Description Returns observation information. Users authenticated with a JWT token will also have access to restricted data associated with their organization.
Parameters:
  • CampaignID
  • SampleID
  • PositionID
  • ObservationID
  • SpeciesCode
  • WormsAphiaID
Example Get first 20000 public observations where speciesCode is 12010 (Turdus iliacus, English Name: "Redwing")
 
Name getEuringListSpecies
Description Data providers can express species data in Observation in two ways:

- Using an ESAS code in SpeciesCode. Set SpeciesCodeType to "ESAS" for that record.
- Using a WoRMS Aphia ID in SpeciesCode. Set SpeciesCodeType to "ERID" for that record.

This service will return the codes for taxa in ESAS.
Parameters:
  • Euring_code
  • AphiaID
  • English_name
  • Scientific_name
Example Get full list of species.
 
Name Token
Description Returns a JSON Web Token (JWT) that enables the user to make API requests that require authentication. A JWT token.
Input [Body (Form Data)]
User (ICES user name)
Password (current password for the ICES user, same that you use in the ICES sharepoint)
Output If successfull, then it will return you the JWT token, you can read more about it here.
URL (POST) https://esas.ices.dk/API/token
 
Name ScreenFile
Description An authenticated user can upload a file to be screened and validated.
The service can be called using post and the file will have to be part of the body of the call.
This service is a pre-requisite to be able to upload data to the database via PushFileToDatabase Service.
Input
fileToScreen (FileStream part of the Body form-data)
SendMail (Is defines if a mail is send when it ends and it is passed in the url)
Output It returns the tblFileScreeninID and this can be used later to query the file screening for messages, status or in case the screening is finished and free of errors to push the file to the database.
URL (POST) https://esas.ices.dk/API/ScreenFile
 
Name getScreeningDetails/{ID}
Description Returns the details of a screening session, no autentication is needed.
Example Example to get the details of session 7
 
Name getScreeningSessionMessages/{ID}
Description Returns a list of messages from a file screening session, no authentication is needed.
Example Example to get the list of messages from session 7
 
Name PushFileToDatabase/{ID}
Description An authenticated user can push a file (identified by Screening Session ID) to the European Seabirds At Sea database.
Requires that the user is the same as the user that generated the Screening Session ID.
The service can be called using post.
Input
ID given in the ScreenESASFile webservice
Output It returns a boolean to say if the file has been uploaded to the database successfuly.
URL (POST) https://esas.ices.dk/API/PushFileToDatabase/{tblFileScreeningID} (e.g: https://esas.ices.dk/API/PushFileToDatabase/1)