The /edsapi/rest/retrieve endpoint retrieves a single record by specifying the accession number (AN) and database identifier (DBID). You can find the AN and DBID in the header of the /edsapi/rest/search response. The results from the /edsapi/rest/search endpoint, even the detailed view, are only a subset of each record. There is no fixed format for an EBSCO article. EBSCO has hundreds of databases, thousands of publishers, and millions of articles. There are a variety of possible formats and data returned in any one article. The /edsapi/rest/search endpoint returns a subset of the article data in a list. The /edsapi/rest/retrieve endpoint returns all of the data for one particular record.

To retrieve a record, you will need the AN and the DBID from the results list. You can find the AN and DBID in the /edsapi/rest/search response as seen below.

<Header>
<DbId>a9h</DbId>
<DbLabel>Academic Search Complete</DbLabel>
<An>376362</An>
<RelevancyScore>2340</RelevancyScore>
</Header>

Endpoint URL for Retrieving Detailed Records

GET /eds-api.ebscohost.com/edsapi/rest/retrieve

POST /eds-api.ebscohost.com/edsapi/rest/retrieve

Data Parameters

To Use the Retrieve Endpoint:

Gather the following information for the request:

Parameter Name	Description	Required/Optional	Parameter Type	Format	Default	Example Values
x-authenticationToken	Token identifying the caller.	Required	Header	string	-	f4714669-ebfa-40d3-acac-bf6e0f22fbb9
x-sessionToken	Token identifying the session this call is in relation to.	Required	Header	string	-	4cc009f9-6acd-4a82-ab9f-0401392431a4.kL9OvDK8pTL7x5YDaaCyzg==
DBID	Database short name specifying which database to retrieve the record from	Required	Query	string		"lfh"
AN	Identifier of the record to obtain	Required	Query	string		"9701242189"
Highlightterms	Terms to highlight in the record	Optional	Query	string[,string]*		"water, air"

The /edsapi/rest/retrieve endpoint supports application/xml or application/json.

Request

GET http://eds-api.ebscohost.com/edsapi/rest/retrieve?dbid=a9h&an=9709140614

{
    "An":"9709140614 ","DbId":"a9h"
}

<RetrieveRequestMessage xmlns="http://epnet.com/webservices/EbscoApi/Contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <An>9709140614 </An>
  <DbId>a9h</DbId>
</RetrieveRequestMessage>

Response

{
   "Record":{
      "ResultId":1,
      "Header":{
         "DbId":"cat01289a",
         "DbLabel":"APVMA Library Catalogue",
         "An":"apvma.2080",
         "PubType":"Book",
         "PubTypeId":"book"
      },
      "PLink":"http:\/\/search.ebscohost.com\/login.aspx?direct=true&site=eds-live&scope=site&db=cat01289a&AN=apvma.2080",
      "FullText":{
         "Text":{
            "Availability":"0"
         },
         "CustomLinks":[
            {
               "Url":"http:\/\/google.com.vn?",
               "Name":"Goolge Demo",
               "Category":"fullText",
               "Text":"Goolge"
            },
            {
               "Url":"http:\/\/eadmin.ebscohost.com?",
               "Name":"edsapi customer link",
               "Category":"fullText",
               "Text":"edsapi link",
               "MouseOverText":"mouse over text"
            }
         ]
      },
      "Items":[
         {
            "Name":"Title",
            "Label":"Title",
            "Group":"Ti",
            "Data":"Petroleum oil products text"
         },
         {
            "Name":"Language",
            "Label":"Language",
            "Group":"Lang",
            "Data":"Undetermined"
         },
         {
            "Name":"PubInfo",
            "Label":"Publication Information",
            "Group":"PubInfo",
            "Data":"1977"
         },
         {
            "Name":"DatePub",
            "Label":"Publication Date",
            "Group":"Date",
            "Data":"1977"
         },
         {
            "Name":"SeriesInfo",
            "Label":"Series",
            "Group":"SersInfo",
            "Data":"FAO specifications for plant protection products CP\/69"
         },
         {
            "Name":"TypePub",
            "Label":"Publication Type",
            "Group":"TypPub",
            "Data":"Book"
         },
         {
            "Name":"TypeDocument",
            "Label":"Document Type",
            "Group":"TypDoc",
            "Data":"Book"
         },
         {
            "Name":"Subject",
            "Label":"Subject Terms",
            "Group":"Su",
            "Data":"<searchLink fieldCode="DE" term="%22PETROLEUM+OIL+PRODUCTS%22">PETROLEUM OIL PRODUCTS<\/searchLink>"
         },
         {
            "Name":"AN",
            "Label":"Accession Number",
            "Group":"ID",
            "Data":"apvma.2080"
         }
      ],
      "RecordInfo":{
         "BibRecord":{
            "BibEntity":{
               "Languages":[
                  {
                     "Text":"Undetermined"
                  }
               ],
               "Subjects":[
                  {
                     "SubjectFull":"PETROLEUM OIL PRODUCTS",
                     "Type":"general"
                  }
               ],
               "Titles":[
                  {
                     "TitleFull":"Petroleum oil products. text.",
                     "Type":"main"
                  }
               ]
            },
            "BibRelationships":{
               "IsPartOfRelationships":[
                  {
                     "BibEntity":{
                        "Dates":[
                           {
                              "D":"01",
                              "M":"01",
                              "Type":"published",
                              "Y":"1977"
                           }
                        ],
                        "Titles":[
                           {
                              "TitleFull":"Petroleum oil products text",
                              "Type":"main"
                           }
                        ]
                     }
                  }
               ]
            }
         }
      },
      "Holdings":[
         {
            "HoldingSimple":{
               "CopyInformationList":[
                  {
                     "Sublocation":"APVMA Library"
                  }
               ]
            }
         }
      ]
   }
}

<RetrieveResponseMessage xmlns="http://epnet.com/webservices/EbscoApi/Contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Record>
    <ResultId>1</ResultId>
    <Header>
      <DbId>cat01289a</DbId>
      <DbLabel>APVMA Library Catalogue</DbLabel>
      <An>apvma.2080</An>
      <PubType>Book</PubType>
      <PubTypeId>book</PubTypeId>
    </Header>
    .
    .
    .
    <FullText>
      <Text>
        <Availability>0</Availability>
      </Text>
      <CustomLinks>
        <CustomLink>
          <Url>http://google.com.vn?</Url>
          <Name>Goolge Demo</Name>
          <Category>fullText</Category>
          <Text>Goolge</Text>
        </CustomLink>
        <CustomLink>
          <Url>http://eadmin.ebscohost.com?</Url>
          <Name>edsapi customer link</Name>
          <Category>fullText</Category>
          <Text>edsapi link</Text>
          <MouseOverText>mouse over text</MouseOverText>
        </CustomLink>
      </CustomLinks>
    </FullText>
    <Items>
      <Item>
        <Name>Title</Name>
        <Label>Title</Label>
        <Group>Ti</Group>
        <Data>Petroleum oil products text</Data>
      </Item>
      <Item>
        <Name>Language</Name>
        <Label>Language</Label>
        <Group>Lang</Group>
        <Data>Undetermined</Data>
      </Item>
      <Item>
        <Name>PubInfo</Name>
        <Label>Publication Information</Label>
        <Group>PubInfo</Group>
        <Data>1977</Data>
      </Item>
      <Item>
        <Name>DatePub</Name>
        <Label>Publication Date</Label>
        <Group>Date</Group>
        <Data>1977</Data>
      </Item>
      <Item>
        <Name>SeriesInfo</Name>
        <Label>Series</Label>
        <Group>SersInfo</Group>
        <Data>FAO specifications for plant protection products CP/69</Data>
      </Item>
      <Item>
        <Name>TypePub</Name>
        <Label>Publication Type</Label>
        <Group>TypPub</Group>
        <Data>Book</Data>
      </Item>
      <Item>
        <Name>TypeDocument</Name>
        <Label>Document Type</Label>
        <Group>TypDoc</Group>
        <Data>Book</Data>
      </Item>
      <Item>
        <Name>Subject</Name>
        <Label>Subject Terms</Label>
        <Group>Su</Group>
        <Data><searchLink fieldCode="DE" term="%22PETROLEUM+OIL+PRODUCTS%22">PETROLEUM OIL PRODUCTS</searchLink></Data>
      </Item>
      <Item>
        <Name>AN</Name>
        <Label>Accession Number</Label>
        <Group>ID</Group>
        <Data>apvma.2080</Data>
      </Item>
    </Items>
    <RecordInfo>
      <BibRecord>
        <BibEntity>
          <Languages>
            <Language>
              <Text>Undetermined</Text>
            </Language>
          </Languages>
          <Subjects>
            <Subject>
              <SubjectFull>PETROLEUM OIL PRODUCTS</SubjectFull>
              <Type>general</Type>
            </Subject>
          </Subjects>
          <Titles>
            <Title>
              <TitleFull>Petroleum oil products. text.</TitleFull>
              <Type>main</Type>
            </Title>
          </Titles>
        </BibEntity>
        <BibRelationships>
          <IsPartOfRelationships>
            <IsPartOf>
              <BibEntity>
                <Dates>
                  <Date>
                    <D>01</D>
                    <M>01</M>
                    <Type>published</Type>
                    <Y>1977</Y>
                  </Date>
                </Dates>
                <Titles>
                  <Title>
                    <TitleFull>Petroleum oil products text</TitleFull>
                    <Type>main</Type>
                  </Title>
                </Titles>
              </BibEntity>
            </IsPartOf>
          </IsPartOfRelationships>
        </BibRelationships>
      </BibRecord>
    </RecordInfo>
    <Holdings>
      <Holding>
        <HoldingSimple>
          <CopyInformationList>
            <CopyInformation>
              <Sublocation>APVMA Library</Sublocation>
            </CopyInformation>
          </CopyInformationList>
        </HoldingSimple>
      </Holding>
    </Holdings>
  </Record>
</RetrieveResponseMessage>

The results will be one record with many Items in it. Start processing with the Label and then the Value. You don’t need to decide which Items to include because all of the Items should be displayed. Typically, the order that the Items are returned is the order in which you display them.

/edsapi/rest/retrieve results are formatted exactly like /edsapi/rest/search results with a few exceptions. In the /edsapi/rest/retrieve results, all metadata fields are returned and the full text element has the link to the article. If there is full text, it is returned for you to display.

Example Retrieve Results Displayed

Designating a Preferred eBook Format Type

An optional query parameter, EbookPreferredFormat , exists for designating a preferred format type for the eBooks full text link. If no value is present, the default format for preferred eBook is used.

Parameter Name	Description	Required/Optional	Format	Default	Example Values
EbookPreferredFormat	EbookPreferredFormat	Optional	string	-	ebook-pub ebook-pdf

Sample ePub Retrieve Request

  <FullText>
    <Links>
      <Link>
       <Type>ebook-epub</Type>
        <Url>http://search.ebscohost.com/login.aspx?direct=true&site=eds-live&scope=site&db=nlebk&AN=478279&ebv=EK&ppid=Page-__-1</Url>;
     </Link>
   </Links>
   <Text>...</Text>
 </FullText>