Impulsive Noise Register

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	intersectPointWithAreas()

	Description	This API of the webservice returns name labels for German Naval blocks, ICES rectangle/sub-division and UK License blocks .

	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 rectangle/sub-division and German Naval blocks
	Example	Example of point in a ICES rectangle/sub-division and UK License blocks


	Name	getDepth()

	Description	This API of the webservice returns a the depth of a position in metres.

	Input	The latitude and longitude of the point in decimal degrees.

	Output	Returns the estimated depth of the point [m] .

	Example	Example of point get depth



	Name	getNoiseBaseData()

	Description	This API of the webservice returns the base data in JSON.

	Input	Year {All available years with data in the database, any other year will return an empty dataset} NoiseValueCode {User can specify any of the Noise levels, you can check here the available codes SourceEvent {User can specify any of the Source Event, you can check here the available codes MitigationSystem {User can specify any of the Types of Noise Mitigation Systems, you can check here the available codes

	Output	Base data .

	Example	Example for getting all the Base Data Example for getting all the Base Data for the year of 2018 Example for getting all the Base Data for the year of 2018 with NA value for the Impact Pile Drivers



	Name	DataDownload(year, NoiseValueCode, SourceEvent)

	Description	This API of the webservice returns the base data in ZIP file.

	Input	Year {All available years with data in the database, any other year will return an empty dataset} NoiseValueCode {User can specify any of the Noise levels, you can check here the available codes SourceEvent {User can specify any of the Source Event, you can check here the available codes EcoRegion {User can specify any of the ICES EcoRegion, but the user can also specify EcoRegion=All, then it will download all the data for the ICES EcoRegions } HelcomSubBasin {User can specify any of the Helcom-Subbasin, but the user can also specify HelcomSubBasin=All, then it will download all the data for the HELCOM Area } OSPARRegion {User can specify any of the OSPAR Region, but the user can also specify OSPARRegion=All, then it will download all the data for the ORPAR Regions } In all the filter specified above, multiple values are accepted

	Output	Base data .

	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()

	Description	This API pushes a screening session to the database.

	Input	Screening SessionID of the file that the user wants to push to the database Note: To call this API the user needs to be autenticathed with a JWT token

	Output	File submission .

	Example	Method is POST Url is: https://underwaternoise.ices.dk/impulsive/api/pushFileDatabase/{SessionID}



	Name	token()

	Description	This API returns a JWT token to the user if the ICES credentials are correct.

	Input	UserName and Password Note: To call this API the user needs to be autenticathed with a

	Output	JWT Token.

	Example	Method is POST Url is: https://underwaternoise.ices.dk/continuous/api/token