{"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.","parameters":[{"name":"locality_no","schema":{"type":"integer"},"required":true,"default":null,"description":"Locality number, e.g. 35297 (from get_lice_report or find_aquaculture_sites' site_nr)."},{"name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}]},"required":false,"default":null,"description":"ISO year. Default: last week."},{"name":"week","schema":{"anyOf":[{"type":"integer"},{"type":"null"}]},"required":false,"default":null,"description":"ISO week 1-53. Default: last week."},{"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)."},{"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."}],"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","null"]},"name":{"type":["string","null"]},"year":{"type":["integer","null"]},"week":{"type":["integer","null"]},"avg_adult_female_lice":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"avg_mobile_lice":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"avg_stationary_lice":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"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":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."}},"ila_protection_zones":{"type":"array","items":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."}},"pd_surveillance_zones":{"type":"array","items":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."}},"pd_protection_zones":{"type":"array","items":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."}}},"additionalProperties":false},"response_schema_status":{"status":"incomplete","codegen_safe":false,"description":"Not suitable for typed model generation: the container shape and field names are useful, but unresolved values accept any JSON value."},"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"}},"required":["self","api_index"],"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/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/marine/get_locality_status","source":"https://allemannsdata.com/wiki/api/v1/kilder/marine"},"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_protection_zones","pd_surveillance_zones","pd_protection_zones"],"output_fields_truncated":false,"canonical_field_aliases":{"name":["name"],"temperature_c":["sea_temperature_c"]}}