{"source":"arkivverket","operation":"search_archives","description":"Search Arkivportalen, the national archive catalogue: fonds, series and\nunits held by Norwegian archive institutions (statsarkiv, byarkiv,\nprivate archives, ...).","parameters":[{"name":"query","schema":{"type":"string"},"required":true,"default":null,"description":"Free-text search, e.g. an organisation, topic or place."},{"name":"limit","schema":{"type":"integer"},"required":false,"default":25,"description":"Results per page, 1-100 (default 25)."},{"name":"page","schema":{"type":"integer"},"required":false,"default":1,"description":"Page number, 1-based (default 1)."},{"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_archives?query={query}&limit=25&page=1&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"total":{"type":["integer","null"]},"total_exact":{"type":"boolean"},"returned":{"type":"integer"},"page":{"type":["integer","null"]},"results":{"type":"array","items":{"anyOf":[{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},{"type":"object","properties":{"urn":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"name":{"type":["string","null"]},"identifier":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"path":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"unit_type":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"institution":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"country":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"digitized_documents":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"history":{"type":"boolean"},"link":{"type":"string"}},"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"],"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_archives/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/arkivverket/search_archives","source":"https://allemannsdata.com/wiki/api/v1/kilder/arkivverket"},"output_fields":["total","total_exact","returned","page","results","results[].urn","results[].name","results[].identifier","results[].path","results[].unit_type","results[].institution","results[].country","results[].digitized_documents","results[].history","results[].link"],"output_fields_truncated":false,"canonical_field_aliases":{"name":["results[].name"],"identifier":["results[].identifier"]}}