Skip to main content

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

Anders Bakkevold
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