FishServe has been engaged by MPI to provide a data aggregation service for Electronic Reporting, which is part of their Digital Monitoring programme.

To find out more about Digital Monitoring, visit the MPI website to view information on their Future of our Fisheries work programme.

FishServe has developed a series of APIs to enable logbooks, developed by 3rd parties, to submit IEMRS event report data. All logbook users must first be authenticated, and all logbooks registered. This can be achieved through our Authentication and Logbook Registration APIs. Once registered all submissions from a logbook must be authenticated via a digital signature. 

For information on getting started, visit;

• Authentication; Used for FishServe APIs and registering logbooks.
• Logbook Registration; Used for registering the public key for the logbook to submit event report data.
• Testing Digital Signatures; For help in setting up and testing digital signatures with your logbook development.

Below is information on the available;

• ERS Event APIs, and 
• ERS Master Data APIs

For more information, you can also visit the following pages;

• FishServe API page: for information on retrieving details such as clients, users for a client or vessel details.
• Alternatively, contact us.

ERS Event APIs

Each API is developed to be stand-alone, but works in conjunction with other APIs, to form the whole picture of your fishing trip.

Each trip would start with a non-fishing event API, such as 'Trip Start' and finish with another non-fishing event API - 'Trip End'.

In between would be all the different fishing and non-fishing events that have occurred on your trip. Each of these would be seperate APIs. 

Generally, each ERS Event has the following API actions available:

• Create (Post): Used to create a new event in your logbook and then post that event
• Get: Used to retrieve an event that has already been created and posted
• Update: Used to update a previous event

Explore the following list of ERS Events to see what APIs are available for use in your own applications.

Production APIs

The following APIs have been released to Production, but are still available in UAT for you to develop and test against. All technical information can be found on our ERS Event APIs in Production page. 

Fishing Event APIs

• Trawl Event: This Event has Create, Get and Update APIs available. 
• Potting Event: This Event has Create, Get and Update APIs available. 
• Netting Event: This Event has Create, Get and Update APIs available. 
• Lining Event: This Event has Create, Get and Update APIs available. 
• Tuna Lining Event: This Event has Create, Get and Update APIs available. 
• Other Lining Event: This Event has Create, Get and Update APIs available. 
• Hand Gathering Event: This Event has Create, Get and Update APIs available. 
• Diving Event: This Event has Create, Get and Update APIs available. 
• Seining Event: This Event has Create, Get and Update APIs available. 
• Jigging Event: This Event has Create, Get and Update APIs available. 
• Dredging Event: This Event has Create, Get and Update APIs available. 

Non-Fishing Event APIs

• Trip Start Event: This Event has Create, Get and Update APIs available. 
• Trip End Event: This Event has Create, Get and Update APIs available. 
• Non-Fish or Protected Species (NFPS) Event: This Event has Create, Get and Update APIs available. 
• Processing Event: This Event has Create, Get and Update APIs available. 
• Disposal Event: This Event has Create, Get and Update APIs available. 
• Landing Event: This Event has Create, Get and Update APIs available.
• Status Check Event: This Event has Create and Get APIs available

 Managing Event APIs

• Find Events: This is an available Get API to retrieve previously submitted events.
• Delete Events This is an available Delete API to delete previously submitted events.
• Schema Editions This is an available Get API to retrice each event schema edition

Back to top

Development APIs

There are currently no API's in development, but all production APIs are available in UAT for you to develop and test against. All technical information can be found on our ERS Event APIs in Development page.

ERS Master Data APIs

Master data APIs retrieve relevant data lists from FishServe, such as fishing methods or species codes, to populate your log book app.

Explore the following list of ERS Master Data APIs to see what are available for use in your own applications.

Production APIs

The following APIs have been released to Production, but are still available in UAT for you to develop and test against. All technical information can be found on our ERS Master Data APIs in Production page.

• Fishing Methods: Retrieve the available fishing methods.
• Species Codes: Retrieve the available species codes.
• Stock Codes: Retrieve the available stock codes.
• Non Fish Protected Species: Retrieve the available non-fish/protected species codes.
• Conversion Factors: Retrieve the available conversion factors for all species, or a single species.
• Product States: Retrieve the available product states.
• Landing Codes: Retrieve the available landing codes.
• Mitigation Devices: Retrieve the available mitigation device codes.
• Disposal Codes: Retrieve the available disposal codes.
• Container Types: Retrieve the available container types.
• Shark Fin Ratios: Retrieve the available shark fin ratios for each species type.
• Seabird Capture Codes: Retrieve the available seabird capture codes.

Back to top