ICES VMS and Logbook





ICES VMS and Logbook database


The ICES VMS and Logbook 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 cetaceans 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 Token
Description In this webservice the user can request a JSON Web Token (JWT) to be able to make requests to the webAPI that require authentication.
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 it succeds, then it will return you the JWT token, you can read more about it here.
URL (POST) https://data.ices.dk/vms/webAPI/token
 
Name ScreenVMSFile
Description In this webservice the user can upload a file to be screen and validated by the VMS database.
The service can be called using post and the file will have to be part of the body of que call. The user needs to be autenticated in order to call this service.
This file can be later pushed to the database by the same user.
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://data.ices.dk/vms/webAPI/ScreenVMSFile
 
Name getScreeningDetails/{ID}
Description In this webservice the user can a get the details of a screening session, no autentication is needed.
Example Example to get the details of session 530
 
Name getScreeningSessionMessages/{ID}
Description In this webservice the user can a get the list of messages from a screening session, no autentication is needed.
Example Example to get the list of messages from session 528
 
Name SendFileToQC/{ID}
Description In this webservice the user can push a file to the VMS database.
The service can be called using post
The user needs to be autenticated and the user needs to be the same that has screened the file.
Input
ID given in the ScreenVMSFile webservice
Output It returns a boolean to say if the file has been uploaded to the database successfuly.
URL (POST) https://data.ices.dk/vms/webAPI/SendFileToQC/{tblFileScreeningID} (e.g: https://data.ices.dk/vms/webAPI/SendFileToQC/564)