Skip to main content

Major update to Fishhealth APIs (2024-11-15)

Anders Bakkevold
BarentsWatch forvaltningsteam

To accomodate for changes in the licereport sent by aquaculture sites weekly, the Fishhealth API will soon have some changes.

Changes in brief

  • A report can now have several Non-medicinal treatments (previously called mechanical removal). These treatments have a specified type.
  • Medicinal treatments (previously called treatments) have an updated data model:
    • They no longer have start- and enddates, they are tied to the reporting week.
    • They have a new optional field NumberOfCages
    • In addition to infeed and bath, 'other' is now an option
  • Combination treatments is added. They consist of a combination of medicinal treatments and/or non-medicinal treatments.

The new data model will soon be in production, but with no data for the new fields. Later on, new licereports will switch to v2 format.

Affected endpoints

  • GET /v1/geodata/fishhealth/locality/{localityId}/{year}/{week}
    • The new version property has value 1 for exisiting data. New reports on the new format will have version 2.
    • Version 2 may have data for combinationTreatments, medicinalTreatments, nonMedicinalTreatments, but never for mechanicalRemoval and treatments.
    • Version 1 may have data for mechanical removal and treatments, but never for combinationtreatments, medicianalTreatments and nonMedicinalTreatments.
    • Modified property: localityWeek
      • Properties changed
        • New property: combinationTreatments
        • New property: medicinalTreatments
        • New property: nonMedicinalTreatments
        • New property: version
  • GET /v1/geodata/fishhealth/locality/{localityNo}/liceMedicationEvents/{year}
    • Modified property: data
      • Items changed
        • Properties changed
          • New property: combinationTreatments
          • New property: nonMedicinalTreatments
          • New property: version
          • Modified property: medicinalTreatments
            • Items changed
              • Properties changed
                • New property: numberOfCages
  • GET /v1/geodata/fishhealth/locality/{year}/{week}
    • New query param: nonMedicinalTreatmentType
  • GET /v1/geodata/fishhealth/{year}/{week}
    • New query param: nonMedicinalTreatmentType
  • GET /v1/geodata/municipality/{municipalityNumber}/treatment
    • Responses changed
      • Modified response: 200
        • Content changed
          • Modified media type: application/json
            • Schema changed
              • Items changed
                • Properties changed
                  • New property: freshWaterTreatmentCount
                  • New property: mechanicalTreatmentCount
                  • New property: otherMedicalTreatmentCount
                  • New property: otherNonMedicalTreatmentCount
                  • New property: thermalTreatmentCount

Removal of WMS layers (2024-04-24)

Anders Bakkevold
BarentsWatch forvaltningsteam

Removal of WMS map layers

The following map layers will be removed from the BarentWatch WMS after the 25th of May 2024.

NavnKartlag
Rakettskytefeltandoya_firing_danger_zone
Fjordlinjer - kysttorskcoastal_cod_regulations_latest
Korallrevcoralreef
Gyteområder torskcodspawningground
Faststående bruk (redskap) Anonymisertfishingfacility_anonymous_utm33
Faststående bruk (redskap) Anonymisert, Nedlastingsversjonfishingfacility_download_anonymous
Ising på fartøyvesselicing_latest
J-meldinger - stengte områderjmelding_view
Laksevassdraglaksevassdrag_view
Oppdrettsanlegg, flate ihht akvakulturregisteretlocalityarea_wms
Maritime grenser - Utvalg for Fiskehelsemaritimeboundary_fishhealth
Maritime grensermaritimeboundary_latest
Maritime grenser (utvalg)maritimeboundary_selected
Elektromagnetiske undersøkelser, Pågåendenpdemsurveyongoing_latest
Elektromagnetiske undersøkelser, Planlagtenpdemsurveyplanned_latest
Havbunnsinstallasjonernpdfacility_latest
Seismikk, pågåendenpdsurveyongoing_latest
Seismikk, planlagtnpdsurveyplanned_latest
Produksjonsområder (grenselinjer)productionarea_lines
Laksefjordersalmonfjord_latest
Rekefeltshrimpfishingground_latest
Fartsområde Bankfiske 1 (siste)tradearea_bankfiske1_latest
Fartsområde fjordfiske (siste)Fartsområde fjordfiske (siste)
Fartsområde kystfiske (siste)tradearea_kystfiske_latest
Fartsområde Liten kystfart (siste)tradearea_litenkystfart_latest
VHF dekningsområdevhf_coverage
VHF dekningsområde (siste)vhf_coverage_latest
Bølgevarsel modellområderwaveforecast_area_geom
Bølgevarsel farlederwaveforecast_fairway_geom
Bølgevarsel farleder (UTM33)waveforecast_fairway_geom_utm33
Bølgevarsel kryssende sjø (label engelsk, nærmeste varsel)waveforecast_xseas_area_current_label_en
Bølgevarsel kryssende sjø (label norsk, nærmeste varsel)waveforecast_xseas_area_current_label_no
Bølgevarsel kryssende sjø (label engelsk)waveforecast_xseas_area_latest_label_en
Bølgevarsel kryssende sjø (label norsk)waveforecast_xseas_area_latest_label_no
Forbudssone kitinsyntesehemmerebw:fmz_kitinsyntesehemmere_latest

Updates to our APIs (2024-02-26): Removing ILA free areas

Svein Magnus Vennevik Johansen
BarentsWatch forvaltningsteam

Fish Health API:

The regulation defining "ILA free areas" was repealed in 2022, and we are missing most historical data. Due to this, we are removing:

  • ...the following endpoints from our API:
    • v1/geodata/fishhealth/ilafreeareas/{year}/{week}
    • v1/geodata/fishhealth/ilafreearea/{year}/{week}/{areaId}
    • v1/geodata/fishhealth/ilafreearea/{year}/{week}/{areaId}/{version}
  • ...the ILAFreeAreas property from the response of this endpoint:
    • v1/geodata/fishhealth/locality/{localityId}/{year}/{week}
  • ...the ilafreearea_wms layer from our WMS service: https://geoserver.barentswatch.no/geoserver/

Updates to our APIs (2023-11-14)

Svein Magnus Vennevik Johansen
BarentsWatch forvaltningsteam

Fish Health API:

  • Added endpoint /v1/geodata/fishhealth/locality/{localityno}/vessel/{year} .
    • Returns the same type of data as /v1/geodata/fishhealth/locality/{localityno}/vessel/{year}/{week} , but as a list of results, one for each week of the year.

See API documentation for details: https://www.barentswatch.no/bwapi/openapi/index.html?urls.primaryName=Fishhealth%20API#/VesselTrackWeek/get_v1_geodata_fishhealth_locality__localityno__vessel__year_

Updates to our APIs (2023-06-06)

Anders Bakkevold
BarentsWatch forvaltningsteam

API endpoint in FishInfo API changed, properties surveyVersion and surveyDataset removed from endpoint /v1/geodata/npdsurveyfisheryexpert/{id}.

See API documentation for details.