{"source":"marine","operation":"get_locality_status","description":"Get the full weekly fish-health status for one aquaculture locality:\nlice counts (adult female / mobile / stationary), sea temperature,\ntreatments that week, and any ILA/PD disease zones it sits in. Signature: get_locality_status(locality_no: integer, required; year: integer, calendar year, optional, default None; week: integer, optional, default None; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0).","signature":"get_locality_status(locality_no: integer, required; year: integer, calendar year, optional, default None; week: integer, optional, default None; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0)","parameters":[{"name":"locality_no","type":"integer","schema":{"type":"integer"},"required":true,"default":null,"description":"Locality number, e.g. 35297 (from get_lice_report or find_aquaculture_sites' site_nr).","unit":null},{"name":"year","type":"integer","schema":{"anyOf":[{"type":"integer"},{"type":"null"}]},"required":false,"default":null,"description":"ISO year. Default: last week. Unit: calendar year.","unit":"calendar year"},{"name":"week","type":"integer","schema":{"anyOf":[{"type":"integer"},{"type":"null"}]},"required":false,"default":null,"description":"ISO week 1-53. Default: last week.","unit":null},{"name":"limit","type":"integer","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"display_type":"integer","required":false,"default":25,"description":"Maximum list items returned by the gateway (default 25, maximum 100).","unit":"items"},{"name":"offset","type":"integer","schema":{"type":"integer","minimum":0,"default":0},"display_type":"integer","required":false,"default":0,"description":"Number of list items to skip before returning the page.","unit":"items"}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/marine/get_locality_status?locality_no={locality_no}&year={year}&week={week}&limit=25&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"locality_no":{"type":"integer"},"name":{"type":["string","null"]},"year":{"type":"integer"},"week":{"type":"integer"},"avg_adult_female_lice":{"type":["number","null"]},"avg_mobile_lice":{"type":["number","null"]},"avg_stationary_lice":{"type":["number","null"]},"sea_temperature_c":{"type":["number","null"]},"has_reported_lice":{"type":["boolean","null"]},"is_fallow":{"type":["boolean","null"]},"has_salmonoids":{"type":["boolean","null"]},"has_mechanical_removal":{"type":["boolean","null"]},"has_bath_treatment":{"type":["boolean","null"]},"has_in_feed_treatment":{"type":["boolean","null"]},"has_cleaner_fish_deployed":{"type":["boolean","null"]},"ila_surveillance_zones":{"type":"array","items":{"type":"object","properties":{"id":{"type":["integer","null"]},"forskNr":{"type":["string","null"]},"forskNavn":{"type":["string","null"]},"forskLink":{"type":["string","null"],"format":"uri"},"sistEndret":{"type":["string","null"],"format":"date-time"},"fromDate":{"type":["string","null"],"format":"date-time"},"toDate":{"type":["string","null"],"format":"date-time"},"originalDate":{"type":["string","null"],"format":"date-time"},"geometry":{"type":"object","properties":{"type":{"type":["string","null"]},"coordinates":{"type":"array"}}}}}},"ila_protection_zones":{"type":"array","items":{"type":"object","properties":{"id":{"type":["integer","null"]},"forskNr":{"type":["string","null"]},"forskNavn":{"type":["string","null"]},"forskLink":{"type":["string","null"],"format":"uri"},"sistEndret":{"type":["string","null"],"format":"date-time"},"fromDate":{"type":["string","null"],"format":"date-time"},"toDate":{"type":["string","null"],"format":"date-time"},"originalDate":{"type":["string","null"],"format":"date-time"},"geometry":{"type":"object","properties":{"type":{"type":["string","null"]},"coordinates":{"type":"array"}}}}}},"pd_surveillance_zones":{"type":"array","items":{"type":"object","properties":{"id":{"type":["integer","null"]},"forskNr":{"type":["string","null"]},"forskNavn":{"type":["string","null"]},"forskLink":{"type":["string","null"],"format":"uri"},"sistEndret":{"type":["string","null"],"format":"date-time"},"fromDate":{"type":["string","null"],"format":"date-time"},"toDate":{"type":["string","null"],"format":"date-time"},"originalDate":{"type":["string","null"],"format":"date-time"},"geometry":{"type":"object","properties":{"type":{"type":["string","null"]},"coordinates":{"type":"array"}}}}}},"pd_protection_zones":{"type":"array","items":{"type":"object","properties":{"id":{"type":["integer","null"]},"forskNr":{"type":["string","null"]},"forskNavn":{"type":["string","null"]},"forskLink":{"type":["string","null"],"format":"uri"},"sistEndret":{"type":["string","null"],"format":"date-time"},"fromDate":{"type":["string","null"],"format":"date-time"},"toDate":{"type":["string","null"],"format":"date-time"},"originalDate":{"type":["string","null"],"format":"date-time"},"geometry":{"type":"object","properties":{"type":{"type":["string","null"]},"coordinates":{"type":"array"}}}}}}},"additionalProperties":false,"required":["locality_no","year","week"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"projected","entity_types":["aquaculture_site"],"description":"Recognized records and stable operation identifiers are projected; an empty array means the successful payload contained no recognizable entity."},"error_contract":{"scope":"top-level HTTP error response; never part of a success payload","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object"}},"additionalProperties":false,"required":["code","message","retryable"]},"suggestion":{"type":"string"},"_meta":{"type":"object","properties":{"retrieved_at":{"type":"string","format":"date-time"},"language":{"type":"string","const":"en"},"content_languages":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}},"required":["retrieved_at","language","content_languages","sources"]},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"api_index":{"type":"string","format":"uri"},"feedback":{"type":"string","format":"uri"}},"required":["self","api_index","feedback"],"additionalProperties":false}},"additionalProperties":false,"required":["error","suggestion","_meta","_links"]},"statuses":{"400":{"codes":["MISSING_PARAMETER","INVALID_PARAMETER","INVALID_REQUEST"],"retryable":false},"404":{"codes":["SOURCE_NOT_FOUND","OPERATION_NOT_FOUND","ENTITY_NOT_FOUND"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"502":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/marine/get_locality_status","operation":"https://allemannsdata.com/wiki/api/v1/kilder/marine/get_locality_status","source":"https://allemannsdata.com/wiki/api/v1/kilder/marine","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["locality_no","name","year","week","avg_adult_female_lice","avg_mobile_lice","avg_stationary_lice","sea_temperature_c","has_reported_lice","is_fallow","has_salmonoids","has_mechanical_removal","has_bath_treatment","has_in_feed_treatment","has_cleaner_fish_deployed","ila_surveillance_zones","ila_surveillance_zones[].id","ila_surveillance_zones[].forskNr","ila_surveillance_zones[].forskNavn","ila_surveillance_zones[].forskLink","ila_surveillance_zones[].sistEndret","ila_surveillance_zones[].fromDate","ila_surveillance_zones[].toDate","ila_surveillance_zones[].originalDate","ila_surveillance_zones[].geometry","ila_surveillance_zones[].geometry.type","ila_surveillance_zones[].geometry.coordinates","ila_protection_zones","ila_protection_zones[].id","ila_protection_zones[].forskNr"],"output_fields_truncated":true,"canonical_field_aliases":{"name":["name"],"temperature_c":["sea_temperature_c"],"identifier":["ila_surveillance_zones[].id","ila_protection_zones[].id","pd_surveillance_zones[].id","pd_protection_zones[].id"]},"response_example":{"source":"marine","operation":"get_locality_status","parameters":{"locality_no":1,"year":1,"week":1},"data":{"locality_no":1,"name":"Example","year":1,"week":1,"avg_adult_female_lice":1.0,"avg_mobile_lice":1.0,"avg_stationary_lice":1.0,"sea_temperature_c":1.0,"has_reported_lice":true,"is_fallow":true,"has_salmonoids":true,"has_mechanical_removal":true,"has_bath_treatment":true,"has_in_feed_treatment":true,"has_cleaner_fish_deployed":true,"ila_surveillance_zones":[{"id":1,"forskNr":"example value","forskNavn":"example value","forskLink":"https://example.invalid/resource","sistEndret":"2026-01-15T12:00:00Z","fromDate":"2026-01-15T12:00:00Z","toDate":"2026-01-15T12:00:00Z","originalDate":"2026-01-15T12:00:00Z","geometry":{"type":"example value","coordinates":[null]}}],"ila_protection_zones":[{"id":1,"forskNr":"example value","forskNavn":"example value","forskLink":"https://example.invalid/resource","sistEndret":"2026-01-15T12:00:00Z","fromDate":"2026-01-15T12:00:00Z","toDate":"2026-01-15T12:00:00Z","originalDate":"2026-01-15T12:00:00Z","geometry":{"type":"example value","coordinates":[null]}}],"pd_surveillance_zones":[{"id":1,"forskNr":"example value","forskNavn":"example value","forskLink":"https://example.invalid/resource","sistEndret":"2026-01-15T12:00:00Z","fromDate":"2026-01-15T12:00:00Z","toDate":"2026-01-15T12:00:00Z","originalDate":"2026-01-15T12:00:00Z","geometry":{"type":"example value","coordinates":[null]}}],"pd_protection_zones":[{"id":1,"forskNr":"example value","forskNavn":"example value","forskLink":"https://example.invalid/resource","sistEndret":"2026-01-15T12:00:00Z","fromDate":"2026-01-15T12:00:00Z","toDate":"2026-01-15T12:00:00Z","originalDate":"2026-01-15T12:00:00Z","geometry":{"type":"example value","coordinates":[null]}}]},"entities":[],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"marine","name":"Aquaculture and fish health","description":"Aquaculture sites, disease status, salmon lice and sea temperature from BarentsWatch.","cache_ttl_seconds":3600}]},"_provenance":{"data":{"source":"marine","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/marine"},"entities":{"source":"marine","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/marine","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/marine/get_locality_status","source":"https://allemannsdata.com/wiki/api/v1/kilder/marine","wiki":"https://allemannsdata.com/wiki/kilder/marine/get_locality_status/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}
