108 lines
31 KiB
Text
108 lines
31 KiB
Text
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" class="no-js no-jr">
|
|
<head>
|
|
<!-- For pinger, set start time and add meta elements. -->
|
|
<script type="text/javascript">var ncbi_startTime = new Date();</script>
|
|
|
|
<!-- Logger begin -->
|
|
<meta name="ncbi_db" content="books">
|
|
<meta name="ncbi_pdid" content="book-part">
|
|
<meta name="ncbi_acc" content="NBK554844">
|
|
<meta name="ncbi_domain" content="about">
|
|
<meta name="ncbi_report" content="reader">
|
|
<meta name="ncbi_type" content="fulltext">
|
|
<meta name="ncbi_objectid" content="">
|
|
<meta name="ncbi_pcid" content="/NBK554844/?report=reader">
|
|
<meta name="ncbi_pagename" content="OAI-PMH Service - About Bookshelf - NCBI Bookshelf">
|
|
<meta name="ncbi_bookparttype" content="chapter">
|
|
<meta name="ncbi_app" content="bookshelf">
|
|
<!-- Logger end -->
|
|
|
|
<!--component id="Page" label="meta"/-->
|
|
<script type="text/javascript" src="/corehtml/pmc/jatsreader/ptpmc_3.22/js/jr.boots.min.js"> </script><title>OAI-PMH Service - About Bookshelf - NCBI Bookshelf</title>
|
|
<meta charset="utf-8">
|
|
<meta name="apple-mobile-web-app-capable" content="no">
|
|
<meta name="viewport" content="initial-scale=1,minimum-scale=1,maximum-scale=1,user-scalable=no">
|
|
<meta name="jr-col-layout" content="auto">
|
|
<meta name="jr-prev-unit" content="/books/n/about/filespec/?report=reader">
|
|
<meta name="jr-next-unit" content="/books/n/about/scientificeval/?report=reader">
|
|
<meta name="bk-toc-url" content="/books/n/about/?report=toc">
|
|
<meta name="robots" content="INDEX,FOLLOW,NOARCHIVE">
|
|
<meta name="citation_inbook_title" content="About Bookshelf [Internet]">
|
|
<meta name="citation_title" content="OAI-PMH Service">
|
|
<meta name="citation_publisher" content="National Center for Biotechnology Information (US)">
|
|
<meta name="citation_date" content="2018/07/26">
|
|
<meta name="citation_fulltext_html_url" content="https://www.ncbi.nlm.nih.gov/books/NBK554844/">
|
|
<link rel="schema.DC" href="http://purl.org/DC/elements/1.0/">
|
|
<meta name="DC.Title" content="OAI-PMH Service">
|
|
<meta name="DC.Type" content="Text">
|
|
<meta name="DC.Publisher" content="National Center for Biotechnology Information (US)">
|
|
<meta name="DC.Date" content="2018/07/26">
|
|
<meta name="DC.Identifier" content="https://www.ncbi.nlm.nih.gov/books/NBK554844/">
|
|
<meta name="description" content="The NCBI Bookshelf OAI-PMH service (Books-OAI) provides access to metadata of all items in the Bookshelf archive, as well as to the full text of a subset of these items.">
|
|
<meta name="og:title" content="OAI-PMH Service">
|
|
<meta name="og:type" content="book">
|
|
<meta name="og:description" content="The NCBI Bookshelf OAI-PMH service (Books-OAI) provides access to metadata of all items in the Bookshelf archive, as well as to the full text of a subset of these items.">
|
|
<meta name="og:url" content="https://www.ncbi.nlm.nih.gov/books/NBK554844/">
|
|
<meta name="og:site_name" content="NCBI Bookshelf">
|
|
<meta name="og:image" content="https://www.ncbi.nlm.nih.gov/corehtml/pmc/pmcgifs/bookshelf/thumbs/th-about-lrg.png">
|
|
<meta name="twitter:card" content="summary">
|
|
<meta name="twitter:site" content="@ncbibooks">
|
|
<meta name="bk-non-canon-loc" content="/books/n/about/oai/?report=reader">
|
|
<link rel="canonical" href="https://www.ncbi.nlm.nih.gov/books/NBK554844/">
|
|
<link href="https://fonts.googleapis.com/css?family=Archivo+Narrow:400,700,400italic,700italic&subset=latin" rel="stylesheet" type="text/css">
|
|
<link rel="stylesheet" href="/corehtml/pmc/jatsreader/ptpmc_3.22/css/libs.min.css">
|
|
<link rel="stylesheet" href="/corehtml/pmc/jatsreader/ptpmc_3.22/css/jr.min.css">
|
|
<meta name="format-detection" content="telephone=no">
|
|
<link rel="stylesheet" href="/corehtml/pmc/css/bookshelf/2.26/css/books.min.css" type="text/css">
|
|
<link rel="stylesheet" href="/corehtml/pmc/css/bookshelf/2.26/css//books_print.min.css" type="text/css" media="print">
|
|
<link rel="stylesheet" href="/corehtml/pmc/css/bookshelf/2.26/css/books_reader.min.css" type="text/css">
|
|
<style type="text/css">p a.figpopup{display:inline !important} .bk_tt {font-family: monospace} .first-line-outdent .bk_ref {display: inline} .body-content h2, .body-content .h2 {border-bottom: 1px solid #97B0C8} .body-content h2.inline {border-bottom: none} a.page-toc-label , .jig-ncbismoothscroll a {text-decoration:none;border:0 !important} .temp-labeled-list .graphic {display:inline-block !important} .temp-labeled-list img{width:100%}</style>
|
|
|
|
<link rel="shortcut icon" href="//www.ncbi.nlm.nih.gov/favicon.ico">
|
|
<meta name="ncbi_phid" content="CE8B2E1F7C8C7901000000000085006E.m_5">
|
|
<meta name='referrer' content='origin-when-cross-origin'/><link type="text/css" rel="stylesheet" href="//static.pubmed.gov/portal/portal3rc.fcgi/4216699/css/3852956/3849091.css"></head>
|
|
<body>
|
|
<!-- Book content! -->
|
|
|
|
|
|
<div id="jr" data-jr-path="/corehtml/pmc/jatsreader/ptpmc_3.22/"><div class="jr-unsupported"><table class="modal"><tr><td><span class="attn inline-block"></span><br />Your browser does not support the NLM PubReader view.<br />Go to <a href="/pmc/about/pr-browsers/">this page</a> to see a list of supported browsers<br />or return to the <br /><a href="/books/NBK554844/?report=classic">regular view</a>.</td></tr></table></div><div id="jr-ui" class="hidden"><nav id="jr-head"><div class="flexh tb"><div id="jr-tb1"><a id="jr-links-sw" class="hidden" title="Links"><svg xmlns="http://www.w3.org/2000/svg" version="1.1" x="0px" y="0px" viewBox="0 0 70.6 85.3" style="enable-background:new 0 0 70.6 85.3;vertical-align:middle" xml:space="preserve" width="24" height="24">
|
|
<style type="text/css">.st0{fill:#939598;}</style>
|
|
<g>
|
|
<path class="st0" d="M36,0C12.8,2.2-22.4,14.6,19.6,32.5C40.7,41.4-30.6,14,35.9,9.8"></path>
|
|
<path class="st0" d="M34.5,85.3c23.2-2.2,58.4-14.6,16.4-32.5c-21.1-8.9,50.2,18.5-16.3,22.7"></path>
|
|
<path class="st0" d="M34.7,37.1c66.5-4.2-4.8-31.6,16.3-22.7c42.1,17.9,6.9,30.3-16.4,32.5h1.7c-66.2,4.4,4.8,31.6-16.3,22.7 c-42.1-17.9-6.9-30.3,16.4-32.5"></path>
|
|
</g>
|
|
</svg> Books</a></div><div class="jr-rhead f1 flexh"><div class="head"><a href="/books/n/about/filespec/?report=reader"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M75,30 c-80,60 -80,0 0,60 c-30,-60 -30,0 0,-60"></path><text x="20" y="28" textLength="60" style="font-size:25px">Prev</text></svg></a></div><div class="body"><div class="t">OAI-PMH Service</div><div class="j">About Bookshelf [Internet]</div></div><div class="tail"><a href="/books/n/about/scientificeval/?report=reader"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M25,30c80,60 80,0 0,60 c30,-60 30,0 0,-60"></path><text x="20" y="28" textLength="60" style="font-size:25px">Next</text></svg></a></div></div><div id="jr-tb2"><a id="jr-bkhelp-sw" class="btn wsprkl hidden" title="Help with NLM PubReader">?</a><a id="jr-help-sw" class="btn wsprkl hidden" title="Settings and typography in NLM PubReader"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" preserveAspectRatio="none"><path d="M462,283.742v-55.485l-29.981-10.662c-11.431-4.065-20.628-12.794-25.274-24.001 c-0.002-0.004-0.004-0.009-0.006-0.013c-4.659-11.235-4.333-23.918,0.889-34.903l13.653-28.724l-39.234-39.234l-28.72,13.652 c-10.979,5.219-23.68,5.546-34.908,0.889c-0.005-0.002-0.01-0.003-0.014-0.005c-11.215-4.65-19.933-13.834-24-25.273L283.741,50 h-55.484l-10.662,29.981c-4.065,11.431-12.794,20.627-24.001,25.274c-0.005,0.002-0.009,0.004-0.014,0.005 c-11.235,4.66-23.919,4.333-34.905-0.889l-28.723-13.653l-39.234,39.234l13.653,28.721c5.219,10.979,5.545,23.681,0.889,34.91 c-0.002,0.004-0.004,0.009-0.006,0.013c-4.649,11.214-13.834,19.931-25.271,23.998L50,228.257v55.485l29.98,10.661 c11.431,4.065,20.627,12.794,25.274,24c0.002,0.005,0.003,0.01,0.005,0.014c4.66,11.236,4.334,23.921-0.888,34.906l-13.654,28.723 l39.234,39.234l28.721-13.652c10.979-5.219,23.681-5.546,34.909-0.889c0.005,0.002,0.01,0.004,0.014,0.006 c11.214,4.649,19.93,13.833,23.998,25.271L228.257,462h55.484l10.595-29.79c4.103-11.538,12.908-20.824,24.216-25.525 c0.005-0.002,0.009-0.004,0.014-0.006c11.127-4.628,23.694-4.311,34.578,0.863l28.902,13.738l39.234-39.234l-13.66-28.737 c-5.214-10.969-5.539-23.659-0.886-34.877c0.002-0.005,0.004-0.009,0.006-0.014c4.654-11.225,13.848-19.949,25.297-24.021 L462,283.742z M256,331.546c-41.724,0-75.548-33.823-75.548-75.546s33.824-75.547,75.548-75.547 c41.723,0,75.546,33.824,75.546,75.547S297.723,331.546,256,331.546z"></path></svg></a><a id="jr-fip-sw" class="btn wsprkl hidden" title="Find"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 550 600" preserveAspectRatio="none"><path fill="none" stroke="#000" stroke-width="36" stroke-linecap="round" style="fill:#FFF" d="m320,350a153,153 0 1,0-2,2l170,170m-91-117 110,110-26,26-110-110"></path></svg></a><a id="jr-rtoc-sw" class="btn wsprkl hidden" title="Table of Contents"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M20,20h10v8H20V20zM36,20h44v8H36V20zM20,37.33h10v8H20V37.33zM36,37.33h44v8H36V37.33zM20,54.66h10v8H20V54.66zM36,54.66h44v8H36V54.66zM20,72h10v8 H20V72zM36,72h44v8H36V72z"></path></svg></a></div></div></nav><nav id="jr-dash" class="noselect"><nav id="jr-dash" class="noselect"><div id="jr-pi" class="hidden"><a id="jr-pi-prev" class="hidden" title="Previous page"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M75,30 c-80,60 -80,0 0,60 c-30,-60 -30,0 0,-60"></path><text x="20" y="28" textLength="60" style="font-size:25px">Prev</text></svg></a><div class="pginfo">Page <i class="jr-pg-pn">0</i> of <i class="jr-pg-lp">0</i></div><a id="jr-pi-next" class="hidden" title="Next page"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M25,30c80,60 80,0 0,60 c30,-60 30,0 0,-60"></path><text x="20" y="28" textLength="60" style="font-size:25px">Next</text></svg></a></div><div id="jr-is-tb"><a id="jr-is-sw" class="btn wsprkl hidden" title="Switch between Figures/Tables strip and Progress bar"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><rect x="10" y="40" width="20" height="20"></rect><rect x="40" y="40" width="20" height="20"></rect><rect x="70" y="40" width="20" height="20"></rect></svg></a></div><nav id="jr-istrip" class="istrip hidden"><a id="jr-is-prev" href="#" class="hidden" title="Previous"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M80,40 60,65 80,90 70,90 50,65 70,40z M50,40 30,65 50,90 40,90 20,65 40,40z"></path><text x="35" y="25" textLength="60" style="font-size:25px">Prev</text></svg></a><a id="jr-is-next" href="#" class="hidden" title="Next"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M20,40 40,65 20,90 30,90 50,65 30,40z M50,40 70,65 50,90 60,90 80,65 60,40z"></path><text x="15" y="25" textLength="60" style="font-size:25px">Next</text></svg></a></nav><nav id="jr-progress"></nav></nav></nav><aside id="jr-links-p" class="hidden flexv"><div class="tb sk-htbar flexh"><div><a class="jr-p-close btn wsprkl">Done</a></div><div class="title-text f1">NCBI Bookshelf</div></div><div class="cnt lol f1"><a href="/books/">Home</a><a href="/books/browse/">Browse All Titles</a><a class="btn share" target="_blank" rel="noopener noreferrer" href="https://www.facebook.com/sharer/sharer.php?u=https://www.ncbi.nlm.nih.gov/books/NBK554844/"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 33 33" style="vertical-align:middle" width="24" height="24" preserveAspectRatio="none"><g><path d="M 17.996,32L 12,32 L 12,16 l-4,0 l0-5.514 l 4-0.002l-0.006-3.248C 11.993,2.737, 13.213,0, 18.512,0l 4.412,0 l0,5.515 l-2.757,0 c-2.063,0-2.163,0.77-2.163,2.209l-0.008,2.76l 4.959,0 l-0.585,5.514L 18,16L 17.996,32z"></path></g></svg> Share on Facebook</a><a class="btn share" target="_blank" rel="noopener noreferrer" href="https://twitter.com/intent/tweet?url=https://www.ncbi.nlm.nih.gov/books/NBK554844/&text=OAI-PMH%20Service"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 33 33" style="vertical-align:middle" width="24" height="24"><g><path d="M 32,6.076c-1.177,0.522-2.443,0.875-3.771,1.034c 1.355-0.813, 2.396-2.099, 2.887-3.632 c-1.269,0.752-2.674,1.299-4.169,1.593c-1.198-1.276-2.904-2.073-4.792-2.073c-3.626,0-6.565,2.939-6.565,6.565 c0,0.515, 0.058,1.016, 0.17,1.496c-5.456-0.274-10.294-2.888-13.532-6.86c-0.565,0.97-0.889,2.097-0.889,3.301 c0,2.278, 1.159,4.287, 2.921,5.465c-1.076-0.034-2.088-0.329-2.974-0.821c-0.001,0.027-0.001,0.055-0.001,0.083 c0,3.181, 2.263,5.834, 5.266,6.438c-0.551,0.15-1.131,0.23-1.73,0.23c-0.423,0-0.834-0.041-1.235-0.118 c 0.836,2.608, 3.26,4.506, 6.133,4.559c-2.247,1.761-5.078,2.81-8.154,2.81c-0.53,0-1.052-0.031-1.566-0.092 c 2.905,1.863, 6.356,2.95, 10.064,2.95c 12.076,0, 18.679-10.004, 18.679-18.68c0-0.285-0.006-0.568-0.019-0.849 C 30.007,8.548, 31.12,7.392, 32,6.076z"></path></g></svg> Share on Twitter</a></div></aside><aside id="jr-rtoc-p" class="hidden flexv"><div class="tb sk-htbar flexh"><div><a class="jr-p-close btn wsprkl">Done</a></div><div class="title-text f1">Table of Content</div></div><div class="cnt lol f1"><a href="/books/n/about/?report=reader">Title Information</a><a href="/books/n/about/toc/?report=reader">Table of Contents Page</a></div></aside><aside id="jr-help-p" class="hidden flexv"><div class="tb sk-htbar flexh"><div><a class="jr-p-close btn wsprkl">Done</a></div><div class="title-text f1">Settings</div></div><div class="cnt f1"><div id="jr-typo-p" class="typo"><div><a class="sf btn wsprkl">A-</a><a class="lf btn wsprkl">A+</a></div><div><a class="bcol-auto btn wsprkl"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 200 100" preserveAspectRatio="none"><text x="10" y="70" style="font-size:60px;font-family: Trebuchet MS, ArialMT, Arial, sans-serif" textLength="180">AUTO</text></svg></a><a class="bcol-1 btn wsprkl"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M15,25 85,25zM15,40 85,40zM15,55 85,55zM15,70 85,70z"></path></svg></a><a class="bcol-2 btn wsprkl"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M5,25 45,25z M55,25 95,25zM5,40 45,40z M55,40 95,40zM5,55 45,55z M55,55 95,55zM5,70 45,70z M55,70 95,70z"></path></svg></a></div></div><div class="lol"><a class="" href="/books/NBK554844/?report=classic">Switch to classic view</a><a href="/books/NBK554844/pdf/Bookshelf_NBK554844.pdf">PDF (74K)</a><a href="/books/n/about/pdf/">PDF (1.7M)</a><a href="/books/NBK554844/?report=printable">Print View</a></div></div></aside><aside id="jr-bkhelp-p" class="hidden flexv"><div class="tb sk-htbar flexh"><div><a class="jr-p-close btn wsprkl">Done</a></div><div class="title-text f1">Help</div></div><div class="cnt f1 lol"><a id="jr-helpobj-sw" data-path="/corehtml/pmc/jatsreader/ptpmc_3.22/" data-href="/corehtml/pmc/jatsreader/ptpmc_3.22/img/bookshelf/help.xml" href="">Help</a><a href="mailto:info@ncbi.nlm.nih.gov?subject=PubReader%20feedback%20%2F%20NBK554844%20%2F%20sid%3ACE8B5AF87C7FFCB1_0191SID%20%2F%20phid%3ACE8B2E1F7C8C7901000000000085006E.4">Send us feedback</a><a id="jr-about-sw" data-path="/corehtml/pmc/jatsreader/ptpmc_3.22/" data-href="/corehtml/pmc/jatsreader/ptpmc_3.22/img/bookshelf/about.xml" href="">About PubReader</a></div></aside><aside id="jr-objectbox" class="thidden hidden"><div class="jr-objectbox-close wsprkl">✘</div><div class="jr-objectbox-inner cnt"><div class="jr-objectbox-drawer"></div></div></aside><nav id="jr-pm-left" class="hidden"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 800" preserveAspectRatio="none"><text font-stretch="ultra-condensed" x="800" y="-15" text-anchor="end" transform="rotate(90)" font-size="18" letter-spacing=".1em">Previous Page</text></svg></nav><nav id="jr-pm-right" class="hidden"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 800" preserveAspectRatio="none"><text font-stretch="ultra-condensed" x="800" y="-15" text-anchor="end" transform="rotate(90)" font-size="18" letter-spacing=".1em">Next Page</text></svg></nav><nav id="jr-fip" class="hidden"><nav id="jr-fip-term-p"><input type="search" placeholder="search this page" id="jr-fip-term" autocorrect="off" autocomplete="off" /><a id="jr-fip-mg" class="wsprkl btn" title="Find"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 550 600" preserveAspectRatio="none"><path fill="none" stroke="#000" stroke-width="36" stroke-linecap="round" style="fill:#FFF" d="m320,350a153,153 0 1,0-2,2l170,170m-91-117 110,110-26,26-110-110"></path></svg></a><a id="jr-fip-done" class="wsprkl btn" title="Dismiss find">✘</a></nav><nav id="jr-fip-info-p"><a id="jr-fip-prev" class="wsprkl btn" title="Jump to previuos match">◀</a><button id="jr-fip-matches">no matches yet</button><a id="jr-fip-next" class="wsprkl btn" title="Jump to next match">▶</a></nav></nav></div><div id="jr-epub-interstitial" class="hidden"></div><div id="jr-content"><article data-type="main"><div class="main-content lit-style" itemscope="itemscope" itemtype="http://schema.org/CreativeWork"><div class="meta-content fm-sec"><div class="fm-sec"><h1 id="_NBK554844_"><span class="title" itemprop="name">OAI-PMH Service</span></h1><p class="fm-aai"><a href="#_NBK554844_pubdet_">Publication Details</a></p><p><em>Estimated reading time: 3 minutes</em></p></div></div><div class="jig-ncbiinpagenav body-content whole_rhythm" data-jigconfig="allHeadingLevels: ['h2'],smoothScroll: false" itemprop="text"><p>The NCBI Bookshelf OAI-PMH service (Books-OAI) provides access to metadata of all items in the Bookshelf archive, as well as to the full text of a subset of these items.</p><p>Books-OAI is an implementation of the Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH), a standard for retrieving metadata from digital document repositories. Visit the <a href="http://www.openarchives.org/" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">Open Archives Initiative site</a> for more information about the protocol and other activities of the OAI group.</p><p>Books-OAI supports OAI-PMH version 2.0. It does not support earlier versions of the protocol.</p><p>If you have questions or comments about this, or any of the other services provided by the NCBI Bookshelf, please write to <a href="mailto:dev@null" data-email="vog.hin.mln.ibcn@flehskoob" class="oemail">vog.hin.mln.ibcn@flehskoob</a>.</p><div id="oai.Copyright"><h2 id="_oai_Copyright_">Copyright</h2><p>Most of the items in this archive are copyright protected, with copyright held by the author(s) or the depositing publisher. In general, the OAI service cannot be used to retrieve the full text of documents in the NCBI Bookshelf. The only exceptions to this policy are for documents that are in the public domain and those that are made available under an Open Access provision (as defined in the <a href="/books/n/about/openaccess/?report=reader">Open Access Subset</a>). See the <a href="/books/n/about/?report=reader">Bookshelf Copyright Notice</a> for more information.</p></div><div id="oai.Using_the_BooksOAI_Service"><h2 id="_oai_Using_the_BooksOAI_Service_">Using the Books-OAI Service</h2><p>The base URL for the service is <a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/</a>.</p><p>See <a href="#oai.Examples">the examples</a>, below, for details about how to use this service to retrieve metadata for books and documents.</p></div><div id="oai.HighVolume_Retrievals"><h2 id="_oai_HighVolume_Retrievals_">High-Volume Retrievals</h2><p>If you are using a script that makes more than 100 requests of any kind, please run it outside of the Bookshelf system's peak hours. Also, please make sure that your system does not make concurrent requests, even at off-peak times. Peak hours are Monday to Friday, 5:00 AM to 9:00 PM, U.S. Eastern time.</p><p>The Books-OAI Service supports HTTP compression, and the Accept-Encoding HTTP header must be set to '<tt>gzip, deflate</tt>' for the most efficient data transfer. See also <a href="http://en.wikipedia.org/wiki/HTTP__compression" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">HTTP compression</a> for further information about this capability.</p></div><div id="oai.Access_to_Full_Text"><h2 id="_oai_Access_to_Full_Text_">Access to Full Text</h2><p>Some Bookshelf participants allow harvesting of the full text of all items, others allow it for only some items, and many do not allow it at all. See the <a href="/books/n/about/openaccess/?report=reader">Open Access Subset</a> for specifics.</p><p>In addition, the parameter <tt>set=book-open</tt> identifies the complete collection of items in Bookshelf for which the full text may be harvested.</p></div><div id="oai.Supported_Data_Formats"><h2 id="_oai_Supported_Data_Formats_">Supported Data Formats</h2><p>Records may be retrieved from the Bookshelf archive in either the “NCBI Book Tag Set” or the “Book Interchange Tag Set” XML format for metadata or full-text book records. A DTD, W3C Schema, and complete documentation for these formats are available from <a href="https://dtd.nlm.nih.gov/" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://dtd.nlm.nih.gov</a> and from <a href="https://jats.nlm.nih.gov/extensions/bits/" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://jats.nlm.nih.gov/extensions/bits/</a>. The prefixes are:</p><p>• Metadata: <tt>metadataPrefix=nbk_meta</tt></p><p>• Full Text: <tt>metadataPrefix=nbk_ftext</tt></p></div><div id="oai.OAI_Books_identifiers"><h2 id="_oai_OAI_Books_identifiers_">OAI Books identifiers</h2><p>The identifiers used by this system are of the form:</p><pre>oai:books.ncbi.nlm.nih.gov:nbkid</pre><p>where <i>nbkid</i> is the numerical portion of the document’s accession ID. For example, the OAI identifier for the document <a href="https://www.ncbi.nlm.nih.gov/books/NBK315783/" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">NBK315783</a> is <a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=GetRecord&identifier=oai:books.ncbi.nlm.nih.gov:315783&metadataPrefix=nbk_meta" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">oai:books.ncbi.nlm.nih.gov:315783</a>.</p></div><div id="oai.Automatic_Segmentation_of_Large_Resu"><h2 id="_oai_Automatic_Segmentation_of_Large_Resu_">Automatic Segmentation of Large Result Sets</h2><p>If a <tt>ListIdentifiers</tt> request results in more than 500 hits, Books-OAI will return the first 500 with a <tt><resumptionToken></tt> that can be used to get the remaining items.</p><p>If a <tt>ListRecords</tt> request results is more than 25 hits for full text or 50 hits for metadata, Books-OAI will return the first 25, or 50 records, respectively, with a <tt><resumptionToken></tt>.</p></div><div id="oai.Examples"><h2 id="_oai_Examples_">Examples</h2><div id="oai.Identify"><h3>Identify</h3><ul><li class="half_rhythm"><div>Identify the Books-OAI interface.</div><div>
|
|
<a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=Identify" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=Identify</a>
|
|
</div></li></ul></div><div id="oai.ListMetadataFormats"><h3>ListMetadataFormats</h3><ul><li class="half_rhythm"><div class="half_rhythm">List all metadata formats.</div><div class="half_rhythm">
|
|
<a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListMetadataFormats" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListMetadataFormats</a>
|
|
</div></li><li class="half_rhythm"><div class="half_rhythm">List metadata formats available for a document with the identifier <tt>oai:books.ncbi.nlm.nih.gov:315783</tt>.</div><div class="half_rhythm">
|
|
<a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListMetadataFormats&identifier=oai:books.ncbi.nlm.nih.gov:315783" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListMetadataFormats&identifier=oai:books.ncbi.nlm.nih.gov:315783</a>
|
|
</div></li></ul></div><div id="oai.ListIdentifiers__return_a_fixed_numb"><h3>ListIdentifiers – return a fixed number of identifiers per request.</h3><p>Typically, the response to this request will contain 500 identifiers, and will include a resumption token at <tt>OAI-PMH/ListSets/resumptionToken</tt>.</p><ul><li class="half_rhythm"><div class="half_rhythm">List (the first set of) identifiers for all documents released in Bookshelf after 1/1/2014 in metadata format.</div><div class="half_rhythm">
|
|
<a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListIdentifiers&from=2014-01-01&metadataPrefix=nbk_meta" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListIdentifiers&from=2014-01-01&metadataPrefix=nbk_meta</a>
|
|
</div></li><li class="half_rhythm"><div class="half_rhythm">If the above request returned the resumption token "<tt>oai%3Abooks.ncbi.nlm.nih.gov%3A179164!2014-01-01!!nbk_meta!</tt>", then the following request returns the next set of identifiers:</div><div class="half_rhythm"><a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListIdentifiers&resumptionToken=oai%3Abooks.ncbi.nlm.nih.gov%3A179164!2014-01-01!!nbk_meta" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListIdentifiers&resumptionToken=oai%3Abooks.ncbi.nlm.nih.gov%3A179164!2014-01-01!!nbk_meta</a>!</div></li><li class="half_rhythm"><div class="half_rhythm">List identifier for documents in the <tt>setSpec</tt> “micad”, released between March to July 2012, and available in full-text XML.</div><div class="half_rhythm">
|
|
<a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListIdentifiers&from=2012-03-01&until=2012-07-31&metadataPrefix=nbk_ftext&set=micad" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListIdentifiers&from=2012-03-01&until=2012-07-31&metadataPrefix=nbk_ftext&set=micad</a>
|
|
</div></li></ul></div><div id="oai.ListRecords__return_a_fixed_number_o"><h3>ListRecords – return a fixed number of records per request.</h3><p>Typically, the response will contain 25 full-text XML records.</p><ul><li class="half_rhythm"><div>List (the first set of) full text XML for the <tt>setSpec</tt> “assayguide” released between 3/22/2014 to 6/12/2014</div><div>
|
|
<a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListRecords&from=2014-03-22&until=2014-06-12&set=assayguide&metadataPrefix=nbk_ftext" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListRecords&from=2014-03-22&until=2014-06-12&set=assayguide&metadataPrefix=nbk_ftext</a>
|
|
</div></li></ul></div><div id="oai.ListSets__return_a_fixed_number_of_s"><h3>ListSets – return a fixed number of sets per request</h3><ul><li class="half_rhythm"><div class="half_rhythm">This response will typically contain the first 500 sets. Use the "resumption token" to get the next set.</div><div class="half_rhythm">
|
|
<a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListSets" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=ListSets</a>
|
|
</div></li></ul></div><div id="oai.GetRecord__retrieve_a_record_by_iden"><h3>GetRecord – retrieve a record by identifier</h3><ul><li class="half_rhythm"><div class="half_rhythm">Get record in Bookshelf metadata XML format with an identifier.</div><div class="half_rhythm">
|
|
<a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=GetRecord&identifier=oai:books.ncbi.nlm.nih.gov:315783&metadataPrefix=nbk_meta" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=GetRecord&identifier=oai:books.ncbi.nlm.nih.gov:315783&metadataPrefix=nbk_meta</a>
|
|
</div></li><li class="half_rhythm"><div class="half_rhythm">Get record in Bookshelf full-text XML format with an identifier.</div><div class="half_rhythm">
|
|
<a href="https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=GetRecord&identifier=oai:books.ncbi.nlm.nih.gov:315783&metadataPrefix=nbk_ftext" ref="pagearea=body&targetsite=external&targetcat=link&targettype=uri">https://api.ncbi.nlm.nih.gov/lit/oai/books/?verb=GetRecord&identifier=oai:books.ncbi.nlm.nih.gov:315783&metadataPrefix=nbk_ftext</a>
|
|
</div></li></ul></div></div><div id="bk_toc_contnr"></div></div></div><div class="fm-sec"><h2 id="_NBK554844_pubdet_">Publication Details</h2><h3>Publication History</h3><p class="small">Last Update: <span itemprop="dateModified">July 26, 2018</span>.</p><h3>Copyright</h3><div><div class="half_rhythm"><a href="/books/about/copyright/">Copyright Notice</a></div></div><h3>Publisher</h3><p><a href="https://www.ncbi.nlm.nih.gov/" ref="pagearea=page-banner&targetsite=external&targetcat=link&targettype=publisher">National Center for Biotechnology Information (US)</a>, Bethesda (MD)</p><h3>NLM Citation</h3><p>About Bookshelf [Internet]. Bethesda (MD): National Center for Biotechnology Information (US); 2010-. OAI-PMH Service. [Updated 2018 Jul 26].<span class="bk_cite_avail"></span></p></div><div class="small-screen-prev"><a href="/books/n/about/filespec/?report=reader"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M75,30 c-80,60 -80,0 0,60 c-30,-60 -30,0 0,-60"></path><text x="20" y="28" textLength="60" style="font-size:25px">Prev</text></svg></a></div><div class="small-screen-next"><a href="/books/n/about/scientificeval/?report=reader"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none"><path d="M25,30c80,60 80,0 0,60 c30,-60 30,0 0,-60"></path><text x="20" y="28" textLength="60" style="font-size:25px">Next</text></svg></a></div></article></div><div id="jr-scripts"><script src="/corehtml/pmc/jatsreader/ptpmc_3.22/js/libs.min.js"> </script><script src="/corehtml/pmc/jatsreader/ptpmc_3.22/js/jr.min.js"> </script></div></div>
|
|
|
|
|
|
|
|
|
|
<!-- Book content -->
|
|
|
|
<script type="text/javascript" src="/portal/portal3rc.fcgi/rlib/js/InstrumentNCBIBaseJS/InstrumentPageStarterJS.js"> </script>
|
|
|
|
|
|
<!-- CE8B5AF87C7FFCB1_0191SID /projects/books/PBooks@9.11 portal104 v4.1.r689238 Tue, Oct 22 2024 16:10:51 -->
|
|
<span id="portal-csrf-token" style="display:none" data-token="CE8B5AF87C7FFCB1_0191SID"></span>
|
|
|
|
<script type="text/javascript" src="//static.pubmed.gov/portal/portal3rc.fcgi/4216699/js/3968615.js" snapshot="books"></script></body>
|
|
</html>
|