The exact match publication feature of EDS API allows you to return a publication that matches a search term. To use this functionality, you must enable Full Text Finder for the account in EBSCOadmin, and institutional holdings must also be populated in EBSCOadmin.

An additional parameter must be added when searching with the /edsapi/rest/search endpoint to return an exact match publication. You can specify whether the exact match publication should be returned along with the search results from EDS API. This setting can be found under the Viewing Publications tab of the edsapi profile in EBSCOadmin. The setting is Show Publication Finder Exact Match Placard on EDS Result List.

Obtain the value of the Show Publication Finder Exact Match Placard on EDS Result List setting by making a call to the /edsapi/rest/info endpoint.

Endpoint URL to Obtain the Setting

GET http://eds-api.ebscohost.com/edsapi/rest/info

Response with the Setting

<InfoResponseMessage>
    <AvailableSearchCriteria>
        <AvailableSorts></AvailableSorts>
        <AvailableSearchFields></AvailableSearchFields>
        <AvailableExpanders></AvailableExpanders>
        <AvailableLimiters></AvailableLimiters>
        <AvailableSearchModes></AvailableSearchModes>
        <AvailableRelatedContent>
            <AvailableRelatedContent>
                <Type>emp</Type>
                <Label>Exact Match Publication</Label>
                <DefaultOn>y</DefaultOn>
                <AddAction>includerelatedcontent(emp)</AddAction>
            </AvailableRelatedContent>
        </AvailableRelatedContent>
    </AvailableSearchCriteria>
    <ViewResultSettings></ViewResultSettings>
    <ApplicationSettings></ApplicationSettings>
    <ApiSettings></ApiSettings>
</InfoResponseMessage>

The value of the setting is returned in the AvailableRelatedContent section of the response in the Type element. If the DefaultOn value of the response is y, then search requests to EDS API should also include the parameter relatedcontent=emp (Type value) or use the action provided. In this example, the action, includerelatedcontent(emp), is found in the AddAction element of the response.

Search Request to Return an Exact Match Publication

GET http://eds-api.ebscohost.com/edsapi/rest/search?query=Economist&relatedcontent=emp

Search Response Returning an Exact Match Publication

<SearchResponseMessageGet>
    <SearchRequestGet></SearchRequestGet>
    <SearchResult>
        <Statistics></Statistics>
        <Data>
            <RecordFormat>EP Display</RecordFormat>
            <Records></Records>
        </Data>
        <RelatedContent>
            <RelatedPublications>
                <RelatedPublication>
                    <Type>emp</Type>
                    <Label>Exact Match Publication</Label>
                    <PublicationRecords>
                       <Record>
                        <ResultId>1</ResultId>
                        <Header>
                            <PublicationId>...</PublicationId>
                            <IsSearchable>...</IsSearchable>
                            <RelevancyScore>...</RelevancyScore>
                            <ResourceType>...</ResourceType>
                        </Header>
                        <PLink>...</PLink>
                        <Items>
                             ...
                            <Item>
                                <Name>...</Name>
                                <Label>...</Label>
                                <Group>...</Group>
                                <Data>...</Data>
                            </Item>
                            ...
                        </Items>
                        <RecordInfo>...</RecordInfo>
                        <FullTextHoldings>
                            <FullTextHolding>
                                <URL>...</URL>
                                <Name>...</Name>
                            </FullTextHolding>
                            ...
                        </FullTextHoldings>
                    </Record>
                </PublicationRecords>
              </RelatedPublication>
          </RelatedPublications>
        </RelatedContent>
        <AvailableFacets></AvailableFacets>
   </SearchResult>
</SearchResponseMessageGet>

In the response message, if an exact match exists, the publication will be returned in a new section of the response called RelatedPublications with a Type of emp.