{"source":"nasjonalbiblioteket","operation":"search_within_item","description":"Full-text search inside the OCR'd pages of one specific digitized item\n(a book, one newspaper issue, a journal issue, etc.), returning which\npages contain the term. Use this to jump straight to relevant pages of\na long item instead of reading it page by page.","parameters":[{"name":"id","schema":{"type":"string"},"required":true,"default":null,"description":"The sesamId or URN from search()/get_item(). Only works for digitized items (accessInfo.digital=true from search()/get_item())."},{"name":"q","schema":{"type":"string"},"required":true,"default":null,"description":"The word or phrase to find."},{"name":"max_pages","schema":{"type":"integer"},"required":false,"default":30,"description":"Max distinct pages to return, 1 to 200 (default 30)."},{"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/nasjonalbiblioteket/search_within_item?id={id}&q={q}&max_pages=30&limit=25&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"id":{"type":["string","null"]},"query":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"total_matches":{"type":"integer"},"pages_truncated":{"type":"boolean"},"pages":{"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":["library_item"],"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/nasjonalbiblioteket/search_within_item/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket/search_within_item","source":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket"},"output_fields":["id","query","total_matches","pages_truncated","pages"],"output_fields_truncated":false,"canonical_field_aliases":{"identifier":["id"]}}