{"source":"arkivverket","operation":"search_census_properties","description":"Search residences / properties (bosteder) in the 1910 census - farms\n(g\u00e5rd/bruk) and urban addresses.","parameters":[{"name":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Free-text term, e.g. \"Slangsvold\" or \"R\u00e5de\". Uses `match`. lat/lon: Point (WGS84) for a nearest-residence search."},{"name":"lat","schema":{"anyOf":[{"type":"number"},{"type":"null"}]},"required":false,"default":null,"description":""},{"name":"lon","schema":{"anyOf":[{"type":"number"},{"type":"null"}]},"required":false,"default":null,"description":""},{"name":"include_persons","schema":{"type":"boolean"},"required":false,"default":false,"description":"Geographic mode only - also return the people living at each matched residence."},{"name":"match","schema":{"type":"string"},"required":false,"default":"all","description":"For free-text only: \"all\" (default) or \"any\"."},{"name":"limit","schema":{"type":"integer"},"required":false,"default":25,"description":"Results per page, 1-100 (default 25). Free-text mode only."},{"name":"page","schema":{"type":"integer"},"required":false,"default":1,"description":"Page number, 1-based (default 1). Free-text mode only."},{"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/arkivverket/search_census_properties?query={query}&lat={lat}&lon={lon}&include_persons=false&match=all&limit=25&page=1&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"count":{"type":["integer","null"]},"returned":{"type":"integer"},"properties":{"type":"array","items":{"type":"object","properties":{"efid":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"gaardsnavn_gateadr":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"bruksnavn":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"gaardsnr":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"bruksnr":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"fylke":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"kommune_sokn":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"coordinates":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"source":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"residents":{"type":"boolean"}},"additionalProperties":false}}},"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":["archive_record","place"],"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/arkivverket/search_census_properties/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/arkivverket/search_census_properties","source":"https://allemannsdata.com/wiki/api/v1/kilder/arkivverket"},"output_fields":["count","returned","properties","properties[].efid","properties[].gaardsnavn_gateadr","properties[].bruksnavn","properties[].gaardsnr","properties[].bruksnr","properties[].fylke","properties[].kommune_sokn","properties[].coordinates","properties[].source","properties[].residents"],"output_fields_truncated":false,"canonical_field_aliases":{}}
