Impulsive Noise Register

Impulsive underwaternoise registry database > Web services (API)


The Impulse Underwater Noise Web Services provide the ability to retrieve data and use the services from the Underwater Noise Register 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 getNoiseBaseData()
Description This API of the webservice returns the base data in JSON.

Parameters:
  • Year
  • NoiseValueCode
  • SourceEvent
  • MitigationSystem
  • EcoRegion
  • OSPARRegion
  • HelcomSubBasin
Example Get all the base data
Get all the base data for the year of 2018
Get all the base data for the year of 2018 with NA value for the Impact Pile Drivers
Example for getting all the Base Data for the year of 2018 in Helcom Sub-basin 'Bornholm Basin'
Example for getting all the Base Data for the year of 2018 in all Helcom Sub-basins
 
Name DataDownload
Description This API of the webservice returns the base data in ZIP file.
Parameters:
  • Year, multiple allowed: year=2021,2022,2024
  • NoiseValueCode
  • SourceEvent
  • MitigationSystem
  • EcoRegion
  • OSPARRegion
  • HelcomSubBasin
Example Example for getting all the Base Data
Example for getting all the Base Data for the year of 2016 and 2018
Example for getting all the Base Data for the year of 2018 and 2019 with NA value for the Impact Pile Drivers
Example for getting all the Base Data for the year of 2019 in the Kiel Bay
Example for getting all the Base Data for the year of 2018 with NA value for the Impact Pile Drivers in the OSPAR region 3
 
Name pushFileDatabase/{ID}
Description An authenticated user can push a file (identified by Screening Session ID) to the impulsive noise registry database. Requires that the user is the same as the user that generated the Screening Session ID. The service can be called using post. This API pushes a screening session to the database.
Input ID given in the Screen of the file in webservice or on-line
Output It returns a boolean to say if the file has been uploaded to the database successfuly.
URL (POST) https://underwaternoise.ices.dk/impulsive/api/pushFileDatabase/{ScreeningID}
 
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