EBSCO Discovery Service (EDS) API User Guide
Contents
1. gt lt searchLink fieldCode DE term 22PARAMYXOVIRUSES 22 gt PARAMY XOVIRUSES lt searchLink gt lt br gt lt searchLink fieldCode DE term 22HAEMOS PORIDA 22 gt HAEMOS PORIDA lt searchLink gt lt Data gt lt Item gt lt Item gt lt Name gt Abstract lt Name gt lt Label gt Abstract lt Label gt lt Group gt Ab lt Group gt lt Data gt The article discusse h indina am the health a Loan any characters are valid for a new URL Put the T eee ae Display every item in the record or decide to skip or include some Ga a me Fess items based on the Group Detailed view includes those items physical abnormaliti transminase values that we think belong in the detailed view so you can just include avian encephalitis v every one of them if you want to haemosporidian a Chlamydophila psittaci antigen in a number of Galapagos Hawks lt Data gt lt Item gt lt Items gt lt Record gt more records on this page lt Records gt lt Data gt lt AvailableFacets gt lt AvailableFacet gt ___ _ Facets are categories by which these specific search results are lt Id gt Journal lt Id gt lt Label gt Publication lt Label gt lt AvailableFacetValues gt lt AvailableFacetValue gt lt Value gt condor lt Value gt lt Count gt 8 lt Count gt lt AddAction gt addfacetfilter Journal condor grouped along with the2. lt relatesTo gt 2 lt relatesTo gt lt br gt lt searchLink fieldCode AR term 22Parker 2C PatriciatG 2E 22 gt Parker Patricia G lt searchLink gt lt relatesTo gt 1 2 lt relatesTo gt lt Data gt lt Item gt lt Item gt lt Name gt TitleSource lt Name gt lt Label gt Source lt Label gt lt Group gt Src lt Group gt EBSCO Discovery Service EDS 15 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com Fea 3 JENJA EBSCO Discovery Service EDS Web API Documentation CD lt Data gt lt searchLink fieldCode JN term 22Journal of Wildlife Diseases 22 gt Journal of Wildlife Diseases lt searchLink gt Jan2012 Vol 48 Issue 1 p39 46 8p ee lt Data gt Some items include searchLinks so the information in the lt Item gt data can be used to create a new search Itis encoded so lt Item gt lt Name gt Subject lt Name gt lt Label gt Subject Terms lt Label fieldCode term together as the query and link the new lt Group gt Su lt Group gt search to the display value at the end of the searchLink lt Data gt lt searchLink fieldCode DE term 22HAWKS 22 gt HAWKS lt searchLink gt lt br gt lt searchLink fieldCode DE term 22 IMMUNOGLOBULINS 22 gt IMMUNOGLOBULINS lt searchLink gt lt br gt lt searchLink fieldCode DE term 22ENCEPHALITIS viruses 22 gt ENCEPHALITIS viruses lt searchLink gt lt br
3. searchLink gt lt Data gt lt Item gt more display items for this record lt Items gt lt Record gt lt RetrieveResponseMessage gt EBSCO Discovery Service EDS Web API User Guide http support ebsco com 20 May 2012 2012 EBSCO Publishing all rights reserved Using the Console to Test Your Queries EBSCO Discovery Service EDS Web API Documentation There is a simple console application available to help you get started and test the various parameters at https eds api ebscohost com Console eee EBSCO Services Authenticate CreateSession Info Search Retrieve EndSession Using the Console Search The Search method is used to perform searches against the databases in the profile It returns a result list along with the relevant facets and abstracts To test the operation using the HTTP GET protocol click the Invoke button Parameters Value Query chinese dissident Search Mode Results Per Page Page Number sort relevance Highlight Include Facets Facet Filters detailed Click on the Authenticate link and enter values User ID Password Response Format XML or JSON Default Value Notes Required The search terms Format op tag term Example SU Hiking Example AND SU Skiing Example Climbing Search made to be used with this search The number of records retrieved with the search results between 1 100 Starting
4. May 2012 2012 EBSCO Publishing all rights reserved C aea EBSCO Discovery Service EDS Web API Documentation Retrieving a Detailed Record Search results even the detailed view are only a subset of each record There is no fixed format for an EBSCO article since we have hundreds of databases thousands of publishers and millions of articles there is a huge variety of possible formats and data returned in any one article The Search method returns a subset of data in a list the Retrieve method gets all the data for one particular record To retrieve a record you ll need the article number An and the database identifier Dbld from the result list The Retrieve syntax is http eds api ebscohost com edsapi rest retrieve dbid a9h amp an 36108341 Note As always an EDS API request must have the authentication token and session token in the http header Use the same process as before do the Retrieve see if any errors come back and if the error is an expired token get a new one before repeating the Retrieve The results will be one record with many items in it Display each item as you get it first the label then the value You don t need to decide which items to include because all items should be displayed Typically the order we return items is the order in which you display them but there might be exceptions for example we usually display the database name at the bottom of the list even though it is returned be
5. The required parameters are e Userld e Password These are your account credentials from EBSCOadmin Authenticate will return lt AuthResponseMessage xmlns http www ebscohost com services public AuthSe rvice Response 2012 06 01 xmins i http www w3 org 2001 XMLSchema instance gt lt AuthToken gt 5 100347 794c 4d9c af8a 40943fc4012b lt AuthToken gt lt AuthTimeout gt 1800 lt AuthTimeout gt lt AuthResponseMessage gt Save the AuthToken you will need it for everything else The endpoint to create a session is http eds api ebscohost com edsapi rest createsession You must first set an http header field called x authenticationToken with the AuthToken you saved from Authenticate CreateSession will return lt CreateSessionResponseMessage xmlns http epnet com webservices EbscoApi Contracts xmlns i http www w3 org 2001 XMLSchema instance gt lt SessionToken gt 8036473a 91cf 435a 92d7 022df3de5313 MoGMwBvTmUwNIHNuQsnyeQ lt SessionToken gt lt CreateSessionResponseMessage gt Save the SessionToken you get back You ll need it for Info Search Retrieve and EndSession The endpoint for Info is http eds api ebscohost com edsapi rest info EBSCO Discovery Service EDS 9 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com CD Bisco EBSCO Discovery Service EDS Web API Documentation Note The AuthToken m
6. all rights reserved http support ebsco com EBSCO xy Understanding a Search Request EBSCO Discovery Service EDS Web API Documentation At its most basic level a search request requires a query term on the GET request you submit to the EDS API using the Search method Many other options can be added to the Search method URL as search parameters These parameters tell the EDS API what fields you want to search the desired sort order how to limit the results how many results belong on a page how many fields to include for each search result Most of the important options have defaults The EDS API then returns a block of XML data with your results In addition to Search there are other methods EBSCO Discovery Service EDS Web API User Guide http support ebsco com All requests must include an Authentication Token and a Session ID so you ll need the Authenticate method the CreateSession method and the EndSession method Authenticate provides a token that must be added to the http header of all subsequent requests CreateSession provides a SessionToken that must be added to the header of all subsequent requests Some options are defined by your EBSCO customer account in EBSCOadmin Use the Info method to find out what limiters you have defined for your EBSCO account and which sort options and search fields you can use with your profile You can use the data returned from the info method to construct a search interfa
7. com 13 May 2012 2012 EBSCO Publishing all rights reserved Fea 3 Esco EBSCO Discovery Service EDS Web API Documentation CD lt BooleanOperator gt AND lt BooleanOperator gt lt FieldCode gt lt Term gt galapagos hawk lt Term gt lt Query gt Number of records found and total lt SearchRequestGet gt lt SearchResult gt lt Statistics gt lt TotalHits gt 93 lt To its gt lt TotalSearchTime gt 1249 lt TotalSearchTime gt lt Databases gt lt Database gt lt Id gt a9h lt Id gt lt Label gt Academic Sear lt Status gt 0 lt S lt Hits gt 19 lt 7Hits gt lt Database gt lt Database gt lt Id gt bth lt Id gt lt Label gt Business Source Complete lt Label gt lt Status gt 0 lt Status gt ar z lt Hits gt 0 lt Hits gt Beginning of the first result identified as Record time in milliseconds Number of results from each of your databases along omplete lt Lay with a status code O success See the EDS API Reference Guide for status codes lt Database gt Resultid is the number of this result in the list of results more databases lt Statistics gt lt Data gt wate eeaadagd Disp ay lt RecorgF Database and article number for this article You ll want to ecordas lt Record gt display the DbLabel not the short Dbld if the user wants to see lt ResultId gt l ResultI this article in full or go to full text the Retrieve method needs
8. e The search box defaults to searching all fields but can also search just the author title subject or publication using the Search method and the FieldCode parameter e Searches can be limited to records in your collection or only full text or peer reviewed articles or both plus many more limiters using the Limiters parameter e Results are paginated and can be sorted You can choose the default sort and the number of articles to retrieve per page using sort and pagesize parameters e The title can be underlined to show that users can click on it taking them to a more detailed page The full article is returned with the Retrieve method e Facets are returned with the results showing the most common attributes of the search results Facets are typically made clickable so the user can reduce the search results to only a particular subject source type of content etc Facets are different for every search because they re based on the results of that search We have two different parameters that let developers request a search modified by parameter EBSCO Discovery Service EDS Web API User Guide http support ebsco com 4 May 2012 2012 EBSCO Publishing all rights reserved SEBSCO czy EBSCO Discovery Service EDS Web API Documentation Authors and publication source are shown in a different color This is entirely a decision of the developer or designer We provide the display value but we als
9. screenshot below we use an example from our VuFind demonstration of the EDS API VuFind is a popular open source catalog search for libraries Our demo has one tab that shows books from the local catalog in the left column and EDS API articles on the right column plus a separate tab for just catalog items and one for just articles This screenshot is from the Articles tab so its results are all articles from EDS You can also load your catalog directly into EDS and show all results on one screen with both books and articles mixed together Choose the display options that fit your library and your user community the best This example illustrates some of the key design features that use the EDS API s Search method EBSCO Discovery Service EDS 3 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com ny SEIA EBSCO Discovery Service EDS Web API Documentation Springfield li b ra ry Language Enghsh Full text arbcle Refine Search homing 1 10 of 4021 for search gakapapes hawk query Ime 22 SELARA nuMe Sot Relevance v Page options Detaled Search lnniters a Text EALTH EVALUATION OF GALAPAGOS HAWS DUTEO OAL APAD OED Row mote Update Sidject Thesawus Term id Adi to fidir G Ful Text Grout UrkSource Pinioaecaranty sf he Olinka Imm utes ANAREN A recert atival to Ne Oabeo aes tilaerds rer rnio Some of the common UI elements shown in this example are
10. system Before breeding young hawks spend 3 4 years as nonterritorial foaters Individuals in this age class are highly gregarious on the istand of Santiago Here we examine patterns in natal dispersal and ask whether they appear to develop social affiliations with particular individuals during their juvenile years Using data collected between 1998 and 2009 from a banded population of 25 territorial groups we found that natal dispersal is more likely to be to territories adjacent to natal territories than expected by chance and is not significantly related to the specific type of vegetation of the natal territory We found no evidence of social affiliations or stable coalitions among particular juveniles instead they moved in opportunistic aggregations ABSTRACT FROM AUTHOR lt RetrieveResponseMessage xmlns http epnet com webservices EbscoApi Contrac ts xmlns i http www w3 org 2001 XMLSchema instance gt lt Record gt lt ResultId gt 1 lt ResultId gt lt Header gt lt DbId gt a9h lt DbId gt lt DbLabel gt Academic Search Complete lt DbLabel gt lt An gt 36108341 lt An gt lt RelevancyScore gt lt Header gt lt PLink gt http search ebscohost com login aspx direct true db a 9h tg AN an 36108341 lt PLink gt lt ImageInfo i nil true gt lt CustomLinks i nil true gt lt FullText gt lt Links gt lt Link gt lt Type gt pdflink lt Type gt lt Url gt http content ebscohost com ContentServer a
11. CustomLinks gt record it will be indicated here so you can choose to lt FullText gt f Gak display the PDF link on your results list When you use the lt Link gt Retrieve command to get the record the actual link will be lt Type gt pdflink lt Type gt returned lt Url gt lt Link gt lt Links gt Because HTML full text is delivered in the body of the lt Text gt d it ilability indicator i tinth Link lt Availability gt 1 lt Availabilit Cord its availability indicator is not in the lt Links gt lt Value gt element but rather in this lt Availability gt element A value lt Text gt of 1 means that HTML will be in the full record returned lt CustomLinks i nil true gt lt FullText gt by the Retrieve method lt Items gt lt Item gt lt Name gt Title lt Name gt lt Label gt Title lt Label gt lt Group gt Ti lt Group gt lt Data gt HEALTH EVALUATION OF GALAPAGOS HAWKS BUTEO GALAPAGOENSIS ON SANTIAGO ISLAND GALAPAGOS lt Data gt lt Item gt lt Item gt lt Name gt Author lt Name gt lt Label gt Authors lt Label gt lt Group gt Au lt Group gt lt Data gt lt searchLink fieldCode AR term 22Deem 2C Sharon L 2E 22 gt Deem Sharon L lt searchLink gt lt relatesTo gt 1 lt relatesTo gt lt i gt deem stlzoo org lt i gt lt br gt lt searchLink fieldCode AR term 22Rivera Parra 2C Jose Luis 22 gt Rivera Parra Jose Luis lt searchLink gt
12. EBSCO Publishing EBSCO Discovery Service EDS API User Guide See EBSCO Discovery Service EDS Web API Documentation scorer servi EBSCO Discovery Service EDS API User Guide Table of Contents What is the EDS APPin aaan ee aaia EE a sued aiasouleovidens tavsd aa a a aaiae iaa 3 Getting Started ep a E E esreen ites eheneaesas 3 Planning Your Access to the EDS API cccccccscsssssorececeesssssanecsececsessaeseeecucacsessaasacsecesesscanaesececaesesssananecess 6 Authentication Method 00 eccccceeccecssceeeseeeesaeeeeecesaeeeeaaeseaaeeseaaesesaeessaeeeeaaeeeaaessaceesaeeeesaeeeeaeeeeaaesseeeeenaees 6 REQUEST FORMATS wsnce ccscess oxatasces anian a e Casuuavetiaeiesdieveasevceeeds E aa E a eai 6 Understanding a Search REQUEST lt ssece ssavesscpazsesessaces Gauges svansacetnateess seuss ia e aeee a ae ea ae e 7 Preparing the Search Sor eeMesssisisassissssseienessndisaos ss drra sse detect A SAK ES ESSEE neS ATES ESSE T aE R ESA SASAS SES OERSET ARESO 8 Authenticate Create Session and get Info cccccccesecccecessesscsececeeecessaeaeeeeecssseseaaeeeeeseseesasaeeeesenseeseaaeas 9 PEHLOKIMING a SCANCH sesceses cvadescaceteseteedscecdavssceteveedeszceadeedaauydosstuasesieu steeds dacddeituvaass EAA EREA 11 Understanding the Search RESults iieri eirese saves aaia t aee tin ivesadseeidssi teens anaE aiK SEEE 13 Retrieving a Detailed RECOM wisiscssssicceveesieesecedccasivewepucdeicecisssdaeccosteues 1esvieei AER
13. EE KEE AE AEE EEEE EERE 18 Using the Console to Test Your Queries ccccssececsesececeesececeenaeeeceeaaeeeseaaeeeeeeaaeeeeseaaeeeseaaeeeeeeaaeeeseeaaeesenaaes 21 Using the Cons Glens seissescisiceessadsaectnmevess ea eE e ee aiaee Ee Oe a E EEEE aai EE SEEE E Ree 21 EBSCO Discovery Service EDS 2 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com CD Bisco EBSCO Discovery Service EDS Web API Documentation What is the EDS API EBSCO s Complete Discovery Solution provides users with access to an institution s entire collection via a single customizable entry point creating an experience that is comprehensive fast and familiar With the EDS API you can integrate EDS directly into your website for a seamless user experience The EDS API supports REST requests via the HTTP GET and POST methods as well as SOAP requests Currently there are two available response formats XML and JSON Getting Started Contact your EBSCO Publishing representative eds ebscohost com to enable your account for API access You ll need to know how you authenticate users into your service by IP address or with your school s UserID and Password Think about why you re using the EDS API and how you want to display the results The API has many options You will probably use only a few of them You ll save a lot of time later if you start with a design for your results page In the
14. acids ONA wad Add to folder D Urbed utent Natal Dispersal ang Socipity of Young Galapagos Hawks on Sart pao Inland Some schools may hardwire some of these options like Brief View or Sort and not present them to the users The options are then added to the search by your code rather than by any choices made by users If you use Info for limiters and sort options you ensure that any changes made to your organization s profile in EBSCOadmin will be reflected in the choices offered to users EBSCO Discovery Service EDS Web API User Guide What sort options do you want to show and which one is displayed as the default Since EDS calculates relevance based on many factors including date it is the best default sort Finally you can decide if you want to return only the Title or a Brief view subjects authors AilText W Find asvances Title Brief or Detailed May 2012 2012 EBSCO Publishing all rights reserved http support ebsco com EBSCO Discovery Service EDS Web API Documentation Before calling Info you need to Authenticate and get a Session ID so we know which profile you re using and that your server is authorized to access it Authenticate Create Session and get Info The endpoint for the Authenticate methods are https eds api ebscohost com authservice rest ipauth https eds api ebscohost com authservice rest uidauth Note The Authenticate request must be a POST
15. at XML or JSON Bisco EBSCO Discovery Service EDS Web API Documentation This will generate the session token and display an XML response You don t need to do anything with this XML response again the console will automatically put the sessionToken in the cookie Use the back button to get to the previous screen Now that both the authentication token and session token have been generated you can use the Info Search and Retrieve methods to see the results Note If the auth session tokens expire you will get an XML error message and you then need to repeat the above steps to get new tokens Click on the Info link and enter the following values Response Format XML This will invoke the Info method for the above profile and return the available sort options search tags expanders and limiters Click on the Search link and enter the following values Query island Search Mode all Page Size 10 Page Number 1 Sort relevance Highlight Y Facets Y Facet Filter Amount of Data to Return detailed Actions Limiters Expanders Response Format XML This will invoke the Search method for the above profile and return e The complete query and the search criteria applied EBSCO Discovery Service EDS Web API User Guide http support ebsco com 22 May 2012 2012 EBSCO Publishing all rights reserved E CD EBSCO Discovery Service EDS Web API Documentation Search
16. ccess methods Yov ll want to decide the following e How to authenticate identify your EBSCO Publishing customer account e The search protocol for calling the EDS API REST or SOAP e The format for results XML or JSON Authentication Method This is how you establish your school s access to EBSCO content The two most common methods are e IP address if you plan to access the API from server s with a fixed IP address e UserID if you might connect to the API from machines outside your network or from many different addresses Request Formats You can use the EDS API with either the REST or SOAP protocol REST is a lighter protocol and it is what we ll use in the examples that follow You can use any EDS API feature through REST or SOAP When using REST you submit requests using either GET or POST Typically GET is used to request data and POST is used to submit data We ll use GET for these examples but again you can choose either one or a combination submitting some requests through GET and some through POST If you re using GET the search parameters go on the URL sent to the EDS API Data is returned from the EDS API in either XML or JSON format We ll use XML for these examples The instructions below apply to both REST and SOAP but the syntax is different for SOAP Refer to the EDS API Reference Guide for the SOAP syntax EBSCO Discovery Service EDS 6 May 2012 Web API User Guide 2012 EBSCO Publishing
17. ce The Search method does not return all the fields for each record or the link to the full text article It brings back metadata for each record so you can display a list of results When the user selects one particular record you use the Retrieve method to obtain the rest of the data including Full Text if available for that article Often you will want to modify an existing search such as using facets to reduce the results to a particular author subject or source Rather than simply start over with a modified search you can use Actions to add additional parameters to the existing search such as facets to reduce the search or pagenumber to go to a specific page The EDS API will recognize that it s a modification of the same search and this will save time and often make your coding easier May 2012 2012 EBSCO Publishing all rights reserved LL 2 SEILA EBSCO Discovery Service EDS Web API Documentation Preparing the Search Screen Some search options should be determined before you execute the search and some are applied after a search to the results of the search Let s look at the decisions you make before your first search 1 What options do you want to provide for search fields and which one is displayed as default We call these FieldCodes They can include author subject title and many others The Info method identifies the FieldCodes available on your account The default search is a keyword search whic
18. fore any of the items Retrieve results are formatted exactly like Search results except that all metadata fields are returned the full text element will now have the link to that article and if there is HTML full text it will be returned for you to display EBSCO Discovery Service EDS 18 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com ed i IA EBSCO Discovery Service EDS Web API Documentation t Service Springfield li b amp Loain ra ry Language English galapagos hawk All Text v Advanced s Prey 8 of 4021 Next gt k Title Natal Dispersal and Sociality of Young Galapagos Hawks on Santiago Island fore HTML full text jane HTML full text Authors Rivara Jose Lyis1 2 jose riveraumsi edu Vargas F Heman View in EDS Parker Patricia G 1 Source Open Ornithology Journal 2011 Vol 4 912 16 5p 1 Chart 1 Map Document Type Article Subject Terms MATING grounds ANIMALS HAWKS ANIMAL breeding DISPERSAL Geographic Terms SAO Tiago Island Cape Verde CAPE Verde Author Supplied Keywords Buteo galapagoensis coalitions floater natal dispersal polyandry NAICS ndustry Codes NAICS Iindustry Codes 112990 All Other Animal Production 115210 Support Activities for Animal Production Abstract The Galapagos Hawk Buteo galapagoensis is the only diurnal resident raptor in the Galapagos Archipelago where it exhibits a cooperatively polyandrous mating
19. h searches all these fields along with the full text if the Also search within the full text of the articles expander is selected 2 What limiters do you want to offer These can include full text peer reviewed in your local collection or dozens of others Typically the most commonly used limiter is full text so that the results of a search are all articles to which you have full access in your EBSCO account source or a more Detailed view including the Abstract Field L Springfield iDrary Code mone E N Full text articles and eBooks from EBSCOhost Discovery Services Sor t __ Refine Search Showing 1 10 of 4021 for search galapagos hawk query Sme 6 03s ay Limiters 22428628 9 0 1 Met om Seat Relevance v Page options Detailed Search limiters O Full Text 3 O Peer Reviewed C Available in Library Collection Show more ton of Gaapags Hawks Buteo galapagoensis on Update i valated Galapagos Hawks for physical abnormal Subjects HAWKS IMMUNOGLOG 5 viruses PARAMYOIOVIRUSES HABMOSPORIDA Subject Thesaurus Term i mat BAG to folder C ANIMAL p G Fd Tet thosh Unisource O siros DNA 4 2 LI ERREERRE BE ed E PREE EE ER PT ORRE S A ical a a O mTocH L ONA 4 e By Bolmer Jerri tract Galinagos hawks Buteo galaoagoensis are one of the most need brd species in ti ted sand popuisbors We used mrtochondral sequence and nes YLOGEOGRAPHY MITOCHONORIAL ONA NUCLEIC
20. hawk query Sme 6 03 2246628 2 2 1 Met eon Sent Relevance Page options Detailed Search limiters O Fut Toot C Peer Reviewed LJ Available in Library Collection Show more zara th Facets Santiago Idand Galapagos Tr s evauated Galapagos Hawks for physical abr g Subjects HAWKS IMMUNOGLOGULINS 5 NS ENCEPHALITIS viruses PARAMYNOVIRUSES HAEMOSPORIDA Subject Thesaurus Term z O Hawks 1 E Add to folder Custom link C ANIMAL poputstions 6 Se G Fd tet troup iriso BIRO o O omaga o MITOCHONDRIAL ONA 4 3 re Subject GALAPAGOS Islands 12 Full text E Adi to oidor ell from EBSCO Urbed umet o C DARWIN Ch Galapagos Islands Guidebooks O animats 4 3 Natal Despers pi ang Society of Young Galapagos Hawka on Sand ago Island The following XML is a small excerpt from a normal results list There will usually be many examples of these different elements Some key elements are highlighted below lt SearchResponseMessageGet xmlns http epnet com webservices EbscoApi Contra cts xmins i http www w3 org 2001 XMLSchema instance gt lt SearchRequestGet gt lt QueryString gt Query 1 AND galapagosthawk amp sort relevance includefacets n searchmode all amp view brief resultsperpage 20 pagenumber 1 amp highlight n lt QueryString gt lt Query gt EBSCO Discovery Service EDS Web API User Guide http support ebsco
21. ight Highlight the search term wherever it shows up in the results Y Action Modify the search by adding an action to it such as to add a facetvalue to the search resort or go to a different page EBSCO Discovery Service EDS 12 Web API User Guide http support ebsco com May 2012 2012 EBSCO Publishing all rights reserved EBSCO Discovery Service EDS Web API Documentation score seriel Understanding the Search Results Unless you get an error back your search results in either XML or JSON will continue all the information you need to identify each record the pieces of data in each record and links you can add to your display if you want users to be able to further refine the search The first section of XML data is information about the query and statistics about the search the next section contains metadata for every record in the result set with items for each type of metadata for that record and the last section of XML is the facets and available values for each facet Here s an example result list made up of the elements from the response Springfield librar amp Loain Language English v Authors zalapagos harwsd All Text Y Find asvances Source Combined Resuts Books amp Mor Articles amp More E i Searchlinks Full text articles and eBooks from EBSCOhost Discovery Servi es Refine Search Showing 1 10 of 4021 for search galfeages
22. ill have to trap for errors though including an expired token just in case A list of other error codes is in the EDS API Reference Guide EBSCO Discovery Service EDS 11 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com Fee 8 EBSCO Discovery Service EDS Web API Documentation SEBSCO xy The full list of parameters and their values can be found in the EDS API Reference Guide The most common ones are listed here Includefacets provide available facets in yorn the results facetfilter Apply a facet to refine the search Sort Sort order Default is relevance Info determines which sorts are available for your account Query Search term including Galapagos hawk or AU Elizabeth Moon or multiple words and which SU mountaineering you can have multiple fields to search terms and use AND or OR to determine if you want any of those queries or all of them Limiter Limiters to apply to the FT y for example to search only for records entire search available with full text available limiters are in the results of Info Searchmode Search mode EDS usually Bool any all smart uses all find all the words in my query View how much detail to show Title Brief or Detailed for each result Resultsperpage Page size Defaults to 20 Pagenumber Which page to show Starts with 1 and pagination is done by asking for page 2 3 etc Highl
23. lt Header gt lt DbId gt eih lt DbI the Dbld and the An lt DbLabel gt Env Yronment Complete lt DbLabel gt lt An gt 70483891 lt An gt SPelevancystore 2060 lt RETEV Permanent link to this article This is often displayed so the lt Header gt lt PLink gt user can save or bookmark it or link into EDS to continue their research http search ebscohost com login aspxo lt PLink gt lt CustomLinks gt lt CustomLink gt lt Url gt http atoz ebsco com directLink 6348 OpenURL sid EBSCO eih gen re article issn 00903558 amp volume 48 amp issue 1 date 20120101 amp spage 39 amp pages 39 46 amp title Journalt of Wildlife Diseases atitle HEALTH EVALUATION OF GALAPAGOS HAWKS BUTEO GALAPAGOENSIS ON SANTIAGO ISLAND S2c GALAPAGOS amp aulast Deem 2c SharontL lt Url gt lt Name gt A to Z as OpenURL all content lt Name gt EBSCO Discovery Service EDS 14 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com Fea 3 JENJA EBSCO Discovery Service EDS Web API Documentation CD lt Category gt other lt Category gt lt Text gt findIt my_Ato Z lt Text gt lt Icon gt lt MouseOverText gt Find full Text through my A to Z list lt MouseOverText gt The links in the full text section are indicators of the type of lt CustomLink gt full text most commonly PDF If PDF is present in the full lt
24. most common results for each facet EBSCO Discovery Service EDS 16 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com Fea 3 SENZA EBSCO Discovery Service EDS Web API Documentation CD lt AddAction gt lt AvailableFacetValue gt lt AvailableFacetValue gt There will be many AvailableFacetValues for lt Value gt molecular ecology resour example each journal that shows up in the results lt Count gt 6 lt Count gt j lt AddAction gt list Typically you ll only want to display the most addfacetfilter Journal moleci common ones Sort them by Count and display those lt AddAction gt i compen i nee val ues fo addfacetfilter You can append the addfacetfilter lt AvailableFacetValues gt action to your search to restrict the results to articles lt AvailableFacet gt lt AvailableFacet gt lt Id gt SourceType lt Id gt lt Label gt Source Type lt Label gt lt AvailableFacetValue gt lt Value gt Academic Journals lt Value gt lt Count gt 38 lt Count gt lt AddAction gt addfacetfilter SourceType Academic Journals lt AddAction gt lt AvailableFacetValue gt more available facet values for this facet lt AvailableFacet gt more facets lt SearchResult gt lt SearchResponseMessageGet gt along with a link that performs the Search Action EBSCO Discovery Service EDS Web API User Guide http support ebsco com 17
25. o provide a searchlink so you can make these fields clickable and search all your databases for that author or publication Only a few lines of the abstract are shown and the search term is highlighted in the abstract You can decide how much of the abstract to show or if you want to skip the abstract The highlight parameter tells the EDS API whether to highlight the search term in the results Links to full text articles are shown as well as what type of article it is In the rest of this document we ll cover how to use the EDS API using this example and go into more detail on the specific methods used by a screen like this We ll use the most common approach the REST API with the HTTP GET protocol These sections are Planning Your Access what formats and protocols will you use Understanding a Search Request a brief overview of the methods you ll use Preparing the Search Screen actions that happen before the first search Performing a Search creating a search Understanding the Search results using the detailed XML results Retrieving a Detailed Record once the user chooses a record get its full text and the rest of its data EBSCO Discovery Service EDS 5 Web API User Guide http support ebsco com May 2012 2012 EBSCO Publishing all rights reserved eee EBSCO Discovery Service EDS Web API Documentation CED Planning Your Access to the EDS API The EDS API supports several a
26. page number for the result set returned frorn a search if page size 10 and page num 3 this implies am expecting 10 records starting at page 3 The sort order for the search results Please use the Info method for a list of common sort options and sort options per database Specifies whether or not the search term is highlighted using lt highlight gt tags Specifies whether or not facets will be returned along with the search results Facets to apply to the search Facets are used to refine previous search results Format group_id tag value tag value Example 1 DE Math DE History Example 2 2G BRAZIL Specifies the amount of data to return with the response Title title only Brief Title Source Subjects Detailed Brief full This will generate the authentication token and display an XML response with that token You don t need to do anything with this XML response because the console automatically adds the authToken to a cookie Use the back button to get to the previous screen keeping the token in the header Cookies must be enabled for the console The console uses a cookie instead of the http header EBSCO Discovery Service EDS Web API User Guide http support ebsco com 21 May 2012 2012 EBSCO Publishing all rights reserved SEE Click on the Create Session link and enter the following values Profile ID Org ID not required Guest Session N Response Form
27. pi rest Search query 1 AND galapagosthawk amp limiter FT y amp expander fulltext amp sort relevance amp includefacets y amp searchm ode all amp view detailed amp resultsperpage 20 amp pagenumber 1 amp highlight y These two searches do the exact same thing as there are default values set for all parameters except the query Remember you must include the x authenticationToken and the x sessionToken in the http headers Because the authentication token could easily have expired you must trap for this response and generate a new token if necessary You don t have to get a new sessionToken when you authenticate because your existing sessionToken is still valid SessionTokens stay valid as long as the user is active Remember to end the session when the user leaves because it is using one of your licenses Note The authentication token is a bit tricky so it s worth a special note here The normal process is e Execute a search with the authToken and sessionToken included in the headers e Ifyou get error 104 Auth Token Invalid get a new token using Authenticate then repeat the search e If you get error 108 Session Token missing get a new SessionToken using CreateSession then repeat the search Some developers will prefer to watch for the expiration time of the token rather than perform a search with an expired one You do this by keeping track of when the token should expire and if it is about to expire create anew one You st
28. sp EbscoContent dGJyMNLe80Sep TU4y9f30LCmr0gep7JSrq 2B4TbKWxWXS amp ContentCustomer dGJyMODb8nm55eGE4bH j fPH X70BA amp T P amp P AN amp S R amp D a 9h amp K 36108341 EBSCO Discovery Service EDS 19 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com ey SEBSCO czy lt EBSCO Discovery Service EDS Web API Documentation Uxr1 gt lt Link gt lt Text gt lt Availability gt 1 lt Availability gt lt Value gt lt anid gt AN0028530099 nhi0lfeb 08 2008Jan22 08 47 v2 2 460 lt anid gt lt jsection id AN0028530099 1 gt SAMPLINGS lt jsection gt lt title id AN0028530099 gt Emergency Broadcast System lt title gt lt p gt Marine iguanas may not be big 2 talkers in fact 1 S C species they don t vocalize at all but at least they re good isteners A new study shows that the wary reptiles tune in to the alarm calls that GalAjpagos mockingbirds broadcast own kind when they spot a common enemy the GalAjpagos hawk lt p gt lt p gt On the island of Santa Fe in the GalAjpagos archipelago Maren N Vitousek a graduate student at Princeton University an two kinds of mockingbird vocalizations an ala ong The team then played back both sounds to groups of iguanas Nearly half the iguanas raised their heads or ran away when they heard the alarm all In contrast fewer than a third reacted birds and mammals are likewise known
29. statistics such as total hit count and search time Database metadata such as number of hits per database database names For each record returned the response will display data such as AN number ISSN plinks title authors subjects abstract etc Facets related to that result set Sort options for that result set Click on the Retrieve link and enter the following values AN 55583895 Database a9h Highlight Y Response Format XML This will invoke the Retrieve method for the above profile and return all the data for the requested record including AN number ISSN Plinks full text title authors subjects abstract any other data included with that specific article Click on the EndSession link and enter the following values Session Id the session ID will be prefilled This will release the session token releasing any user licenses For any subsequent searches a new session token will need to be generated by using the CreateSession method EBSCO Discovery Service EDS 23 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com
30. to heed the warnings of other biologists to suggest that alarm calls may sha provoke reac tions across species But the resp iguanas requires other explanations either th know what the bird calls mean or they can lea fashion that the calls announce the imminent predator Biology Letters lt p gt lt p gt lt img src http imagesrvr epnet com img embimages host1l dGJyMNI title Marine iguanas expert eavesdroppers StA ephan Reebs lt p gt lt aug gt for the benefit of their d thr colleagues recorded rm call and a territorial to the song lt p gt lt p gt Various Those eavesdroppers all make alarm calls of their own prompting re acoustical features that onsiveness of the mute e iguanas instinctively rn over time in Pavlovian arrival of a dreaded rdk nhi Olfeb08 12n2 jpg ep Lr40Sepq84y9f30LCmr0gepq5Srqa4SK6WxWxS alt 12n2 jpg gt lt p gt lt aug gt lt p gt By lt Value gt lt Text gt lt CustomLinks i nil true gt lt FullText gt lt Items gt lt Item gt lt Name gt Title lt Name gt lt Label gt Title lt Label gt lt Group gt Ti lt Group gt lt Data gt Emergency Broadcast System lt Data gt lt Item gt lt Item gt lt Name gt Author lt Name gt lt Label gt Authors lt Label gt lt Group gt Au lt Group gt lt Data gt lt searchLink fieldCode AR term 22Reebs 2C StA ephan 22 gt Reebs StA ephan lt
31. ust be in the http header x authenticationToken and the SessionToken must be in a header field x sessionToken for Info to work This is probably a good time to end the session You won t need to ask for Info again because it applies to all users so you can think of this setup session as being one time that serves all users Each user needs a unique session for searching because the session takes up a license for those databases with limited licenses and keeps information about the current user session to simplify future searches Since the Info method doesn t apply to just one user it is reasonable to create a session for Info then end that session You don t need to end the session now but you need to end it before the user leaves The syntax for EndSession is http eds api ebscohost com edsapi rest endsession You ll need the x sessionToken EBSCO Discovery Service EDS 10 May 2012 Web API User Guide 2012 EBSCO Publishing all rights reserved http support ebsco com CD Bisco EBSCO Discovery Service EDS Web API Documentation Performing a Search Once you ve decided which pre search options to present on the screen you can ask the user for the search query A simple search for Galapagos hawk can look like this because the other important parameters are set by default http eds api ebscohost com edsapi rest Search query 1 AND galapagos hawk It can also look like this http eds api ebscohost com edsa
Download Pdf Manuals
Related Search