The options that you can use with EDS API are defined by your EBSCO customer account in EBSCOadmin. Use the /edsapi/rest/info endpoint to obtain option information. From the option information, you can determine which limiters you have defined for your EBSCO account. You can also determine which sort options and search fields that you can use with your profile. You can use the data returned from the /edsapi/rest/info endpoint to construct a search interface.

When you retrieve option information for a profile, the response contains the sort options, search fields, limiters and expanders available to the profile. Before calling the /edsapi/rest/info endpoint, you need to create a session token for the profile that you are using.

Endpoint URL for Obtaining Option Information

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

POST https://eds-api.ebscohost.com/edsapi/rest/info

Data Parameters

To Use the Info 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	-	d15544f3-4bb6-4e8f-9106-99dc53003da5
x-sessionToken	Token identifying the session this call is in relation to.	Required	Header	string		4cc009f9-6acd-4a82-ab9f-0401392431a4.kL9OvDK8pTL7x5YDaaCyzg==

/edsapi/rest/info supports application/xml or application/json.

Request

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

Response

{
   "AvailableSearchCriteria":{
      "AvailableSorts":[
         {
            "Id":"relevance",
            "Label":"Relevance",
            "AddAction":"setsort(relevance)"
         },
         {
            "Id":"date",
            "Label":"Date Newest",
            "AddAction":"setsort(date)"
         },
         {
            "Id":"date2",
            "Label":"Date Oldest",
            "AddAction":"setsort(date2)"
         },
         {
            "Id":"author",
            "Label":"Author",
            "AddAction":"setsort(author)"
         }
      ],
      "AvailableSearchFields":[
         {
            "FieldCode":"TX",
            "Label":"All Text"
         },
         {
            "FieldCode":"AU",
            "Label":"Author"
         },
         {
            "FieldCode":"TI",
            "Label":"Title"
         },
         {
            "FieldCode":"SU",
            "Label":"Subject Terms"
         },
         {
            "FieldCode":"SO",
            "Label":"Source"
         },
         {
            "FieldCode":"AB",
            "Label":"Abstract"
         },
         {
            "FieldCode":"IS",
            "Label":"ISSN"
         },
         {
            "FieldCode":"IB",
            "Label":"ISBN"
         }
      ],
      "AvailableExpanders":[
         {
            "Id":"relatedsubjects",
            "Label":"Apply equivalent subjects",
            "AddAction":"addexpander(relatedsubjects)",
            "DefaultOn":"n"
         },
         {
            "Id":"thesaurus",
            "Label":"Apply related words",
            "AddAction":"addexpander(thesaurus)",
            "DefaultOn":"n"
         },
         {
            "Id":"fulltext",
            "Label":"Also search within the full text of the articles",
            "AddAction":"addexpander(fulltext)",
            "DefaultOn":"y"
         }
      ],
      "AvailableLimiters":[
         {
            "Id":"FT",
            "Label":"Linked Full Text",
            "Type":"select",
            "AddAction":"addlimiter(FT:value)",
            "DefaultOn":"n",
            "Order":"1"
         },
         {
            "Id":"FR",
            "Label":"References Available",
            "Type":"select",
            "AddAction":"addlimiter(FR:value)",
            "DefaultOn":"n",
            "Order":"2"
         },
         {
            "Id":"RV",
            "Label":"Scholarly (Peer Reviewed) Journals",
            "Type":"select",
            "AddAction":"addlimiter(RV:value)",
            "DefaultOn":"n",
            "Order":"3"
         },
         {
            "Id":"DT1",
            "Label":"Publication Date",
            "Type":"ymrange",
            "AddAction":"addlimiter(DT1:value)",
            "DefaultOn":"n",
            "Order":"4"
         },
         {
            "Id":"AU",
            "Label":"Author",
            "Type":"text",
            "AddAction":"addlimiter(AU:value)",
            "DefaultOn":"n",
            "Order":"5"
         },
         {
            "Id":"SO",
            "Label":"Publication",
            "Type":"text",
            "AddAction":"addlimiter(SO:value)",
            "DefaultOn":"n",
            "Order":"6"
         },
         {
            "Id":"TI",
            "Label":"Title",
            "Type":"text",
            "AddAction":"addlimiter(TI:value)",
            "DefaultOn":"n",
            "Order":"7"
         },
         {
            "Id":"FT1",
            "Label":"Available in Library Collection",
            "Type":"select",
            "AddAction":"addlimiter(FT1:value)",
            "DefaultOn":"n",
            "Order":"8"
         },
         {
            "Id":"LA99",
            "Label":"Language",
            "Type":"multiselectvalue",
            "LimiterValues":[
               {
                  "Value":"Afrikaans",
                  "AddAction":"addlimiter(LA99:Afrikaans)"
               },
               {
                  "Value":"Chinese",
                  "AddAction":"addlimiter(LA99:Chinese)"
               },
               {
                  "Value":"Croatian",
                  "AddAction":"addlimiter(LA99:Croatian)"
               },
               {
                  "Value":"Czech",
                  "AddAction":"addlimiter(LA99:Czech)"
               },
               {
                  "Value":"Dutch\/Flemish",
                  "AddAction":"addlimiter(LA99:Dutch\/Flemish)"
               },
               {
                  "Value":"English",
                  "AddAction":"addlimiter(LA99:English)"
               },
               {
                  "Value":"Finnish",
                  "AddAction":"addlimiter(LA99:Finnish)"
               },
               {
                  "Value":"French",
                  "AddAction":"addlimiter(LA99:French)"
               },
               {
                  "Value":"German",
                  "AddAction":"addlimiter(LA99:German)"
               },
               {
                  "Value":"Hungarian",
                  "AddAction":"addlimiter(LA99:Hungarian)"
               },
               {
                  "Value":"Italian",
                  "AddAction":"addlimiter(LA99:Italian)"
               },
               {
                  "Value":"Japanese",
                  "AddAction":"addlimiter(LA99:Japanese)"
               },
               {
                  "Value":"Lithuanian",
                  "AddAction":"addlimiter(LA99:Lithuanian)"
               },
               {
                  "Value":"Norwegian",
                  "AddAction":"addlimiter(LA99:Norwegian)"
               },
               {
                  "Value":"Persian",
                  "AddAction":"addlimiter(LA99:Persian)"
               },
               {
                  "Value":"Polish",
                  "AddAction":"addlimiter(LA99:Polish)"
               },
               {
                  "Value":"Portuguese",
                  "AddAction":"addlimiter(LA99:Portuguese)"
               },
               {
                  "Value":"Romanian",
                  "AddAction":"addlimiter(LA99:Romanian)"
               },
               {
                  "Value":"Russian",
                  "AddAction":"addlimiter(LA99:Russian)"
               },
               {
                  "Value":"Serbian",
                  "AddAction":"addlimiter(LA99:Serbian)"
               },
               {
                  "Value":"Slovak",
                  "AddAction":"addlimiter(LA99:Slovak)"
               },
               {
                  "Value":"Slovenian",
                  "AddAction":"addlimiter(LA99:Slovenian)"
               },
               {
                  "Value":"Spanish",
                  "AddAction":"addlimiter(LA99:Spanish)"
               },
               {
                  "Value":"Swahili",
                  "AddAction":"addlimiter(LA99:Swahili)"
               },
               {
                  "Value":"Swedish",
                  "AddAction":"addlimiter(LA99:Swedish)"
               },
               {
                  "Value":"Turkish",
                  "AddAction":"addlimiter(LA99:Turkish)"
               },
               {
                  "Value":"Arabic",
                  "AddAction":"addlimiter(LA99:Arabic)"
               },
               {
                  "Value":"Aragonese",
                  "AddAction":"addlimiter(LA99:Aragonese)"
               },
               {
                  "Value":"Bosnian",
                  "AddAction":"addlimiter(LA99:Bosnian)"
               },
               {
                  "Value":"Breton",
                  "AddAction":"addlimiter(LA99:Breton)"
               },
               {
                  "Value":"Catalan; Valencian",
                  "AddAction":"addlimiter(LA99:Catalan; Valencian)"
               },
               {
                  "Value":"Danish",
                  "AddAction":"addlimiter(LA99:Danish)"
               },
               {
                  "Value":"Dutch; Flemish",
                  "AddAction":"addlimiter(LA99:Dutch; Flemish)"
               },
               {
                  "Value":"Galician",
                  "AddAction":"addlimiter(LA99:Galician)"
               },
               {
                  "Value":"Indonesian",
                  "AddAction":"addlimiter(LA99:Indonesian)"
               },
               {
                  "Value":"Latin",
                  "AddAction":"addlimiter(LA99:Latin)"
               },
               {
                  "Value":"Slavic languages",
                  "AddAction":"addlimiter(LA99:Slavic languages)"
               },
               {
                  "Value":"Spanish; Castilian",
                  "AddAction":"addlimiter(LA99:Spanish; Castilian)"
               },
               {
                  "Value":"Ukrainian",
                  "AddAction":"addlimiter(LA99:Ukrainian)"
               }
            ],
            "DefaultOn":"n",
            "Order":"9"
         }
      ],
      "AvailableSearchModes":[
         {
            "Mode":"bool",
            "Label":"Boolean\/Phrase",
            "DefaultOn":"y",
            "AddAction":"setsearchmode(bool)"
         },
         {
            "Mode":"all",
            "Label":"Find all my search terms",
            "DefaultOn":"n",
            "AddAction":"setsearchmode(all)"
         },
         {
            "Mode":"any",
            "Label":"Find any of my search terms",
            "DefaultOn":"n",
            "AddAction":"setsearchmode(any)"
         },
         {
            "Mode":"smart",
            "Label":"SmartText Searching",
            "DefaultOn":"n",
            "AddAction":"setsearchmode(smart)"
         }
      ],
      "AvailableRelatedContent":[
         {
            "Type":"emp",
            "Label":"Exact Match Publication",
            "DefaultOn":"y",
            "AddAction":"includerelatedcontent(emp)"
         }
      ],
      "AvailableDidYouMeanOptions":[
         {
            "Id":"AutoSuggest",
            "Label":"Did You Mean",
            "DefaultOn":"y"
         },
         {
            "Id":"AutoCorrect",
            "Label":"Auto Correct",
            "DefaultOn":"y"
         }
      ]
   },
   "ViewResultSettings":{
      "ResultsPerPage":"20",
      "ResultListView":"brief",
      "IncludeImageQuickView": {
          "Id": "ImageQuickViewResults",
          "Label": "Image Quick View Results",
          "DefaultOn": "n"
       }
    },
   "ApplicationSettings":{
      "SessionTimeout":"480"
   },
   "ApiSettings":{
      "MaxRecordJumpAhead":"250"
   },
   "ExportFormatSettings": {
      "AvailableFormats": [{
          "Id": "RIS",
          "Label": "RIS Format"
      }]
   },
   "CitationStyleSettings": {
        "AvailableStyles": [{
            "Id": "mla",
            "Label": "MLA"
        },
        {
            "Id": "chicago",
            "Label": "Chicago/Turabian: Author-Date"
        }]
    }
}

<InfoResponseMessage xmlns="http://epnet.com/webservices/EbscoApi/Contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AvailableSearchCriteria>
    <AvailableSorts>
      <AvailableSort>
        <Id>relevance</Id>
        <Label>Relevance</Label>
        <AddAction>setsort(relevance)</AddAction>
      </AvailableSort>
      <AvailableSort>
        <Id>date</Id>
        <Label>Date Newest</Label>
        <AddAction>setsort(date)</AddAction>
      </AvailableSort>
      <AvailableSort>
        <Id>date2</Id>
        <Label>Date Oldest</Label>
        <AddAction>setsort(date2)</AddAction>
      </AvailableSort>
      <AvailableSort>
        <Id>author</Id>
        <Label>Author</Label>
        <AddAction>setsort(author)</AddAction>
      </AvailableSort>
    </AvailableSorts>
    <AvailableSearchFields>
      <AvailableSearchField>
        <FieldCode>TX</FieldCode>
        <Label>All Text</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>AU</FieldCode>
        <Label>Author</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>TI</FieldCode>
        <Label>Title</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>SU</FieldCode>
        <Label>Subject Terms</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>SO</FieldCode>
        <Label>Source</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>AB</FieldCode>
        <Label>Abstract</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>IS</FieldCode>
        <Label>ISSN</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>IB</FieldCode>
        <Label>ISBN</Label>
      </AvailableSearchField>
    </AvailableSearchFields>
    <AvailableExpanders>
      <AvailableExpander>
        <Id>relatedsubjects</Id>
        <Label>Apply equivalent subjects</Label>
        <AddAction>addexpander(relatedsubjects)</AddAction>
        <DefaultOn>n</DefaultOn>
      </AvailableExpander>
      <AvailableExpander>
        <Id>thesaurus</Id>
        <Label>Apply related words</Label>
        <AddAction>addexpander(thesaurus)</AddAction>
        <DefaultOn>n</DefaultOn>
      </AvailableExpander>
      <AvailableExpander>
        <Id>fulltext</Id>
        <Label>Also search within the full text of the articles</Label>
        <AddAction>addexpander(fulltext)</AddAction>
        <DefaultOn>y</DefaultOn>
      </AvailableExpander>
    </AvailableExpanders>
    <AvailableLimiters>
      <AvailableLimiter>
        <Id>FT</Id>
        <Label>Linked Full Text</Label>
        <Type>select</Type>
        <AddAction>addlimiter(FT:value)</AddAction>
        <DefaultOn>n</DefaultOn>
        <Order>1</Order>
      </AvailableLimiter>
      <AvailableLimiter>
        <Id>FR</Id>
        <Label>References Available</Label>
        <Type>select</Type>
        <AddAction>addlimiter(FR:value)</AddAction>
        <DefaultOn>n</DefaultOn>
        <Order>2</Order>
      </AvailableLimiter>
      <AvailableLimiter>
        <Id>RV</Id>
        <Label>Scholarly (Peer Reviewed) Journals</Label>
        <Type>select</Type>
        <AddAction>addlimiter(RV:value)</AddAction>
        <DefaultOn>n</DefaultOn>
        <Order>3</Order>
      </AvailableLimiter>
      <AvailableLimiter>
        <Id>DT1</Id>
        <Label>Publication Date</Label>
        <Type>ymrange</Type>
        <AddAction>addlimiter(DT1:value)</AddAction>
        <DefaultOn>n</DefaultOn>
        <Order>4</Order>
      </AvailableLimiter>
      <AvailableLimiter>
        <Id>AU</Id>
        <Label>Author</Label>
        <Type>text</Type>
        <AddAction>addlimiter(AU:value)</AddAction>
        <DefaultOn>n</DefaultOn>
        <Order>5</Order>
      </AvailableLimiter>
      <AvailableLimiter>
        <Id>SO</Id>
        <Label>Publication</Label>
        <Type>text</Type>
        <AddAction>addlimiter(SO:value)</AddAction>
        <DefaultOn>n</DefaultOn>
        <Order>6</Order>
      </AvailableLimiter>
      <AvailableLimiter>
        <Id>TI</Id>
        <Label>Title</Label>
        <Type>text</Type>
        <AddAction>addlimiter(TI:value)</AddAction>
        <DefaultOn>n</DefaultOn>
        <Order>7</Order>
      </AvailableLimiter>
      <AvailableLimiter>
        <Id>FT1</Id>
        <Label>Available in Library Collection</Label>
        <Type>select</Type>
        <AddAction>addlimiter(FT1:value)</AddAction>
        <DefaultOn>n</DefaultOn>
        <Order>8</Order>
      </AvailableLimiter>
      <AvailableLimiter>
        <Id>LA99</Id>
        <Label>Language</Label>
        <Type>multiselectvalue</Type>
        <LimiterValues>
          <LimiterValue>
            <Value>Afrikaans</Value>
            <AddAction>addlimiter(LA99:Afrikaans)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Chinese</Value>
            <AddAction>addlimiter(LA99:Chinese)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Croatian</Value>
            <AddAction>addlimiter(LA99:Croatian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Czech</Value>
            <AddAction>addlimiter(LA99:Czech)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Dutch/Flemish</Value>
            <AddAction>addlimiter(LA99:Dutch/Flemish)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>English</Value>
            <AddAction>addlimiter(LA99:English)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Finnish</Value>
            <AddAction>addlimiter(LA99:Finnish)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>French</Value>
            <AddAction>addlimiter(LA99:French)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>German</Value>
            <AddAction>addlimiter(LA99:German)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Hungarian</Value>
            <AddAction>addlimiter(LA99:Hungarian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Italian</Value>
            <AddAction>addlimiter(LA99:Italian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Japanese</Value>
            <AddAction>addlimiter(LA99:Japanese)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Lithuanian</Value>
            <AddAction>addlimiter(LA99:Lithuanian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Norwegian</Value>
            <AddAction>addlimiter(LA99:Norwegian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Persian</Value>
            <AddAction>addlimiter(LA99:Persian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Polish</Value>
            <AddAction>addlimiter(LA99:Polish)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Portuguese</Value>
            <AddAction>addlimiter(LA99:Portuguese)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Romanian</Value>
            <AddAction>addlimiter(LA99:Romanian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Russian</Value>
            <AddAction>addlimiter(LA99:Russian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Serbian</Value>
            <AddAction>addlimiter(LA99:Serbian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Slovak</Value>
            <AddAction>addlimiter(LA99:Slovak)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Slovenian</Value>
            <AddAction>addlimiter(LA99:Slovenian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Spanish</Value>
            <AddAction>addlimiter(LA99:Spanish)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Swahili</Value>
            <AddAction>addlimiter(LA99:Swahili)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Swedish</Value>
            <AddAction>addlimiter(LA99:Swedish)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Turkish</Value>
            <AddAction>addlimiter(LA99:Turkish)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Arabic</Value>
            <AddAction>addlimiter(LA99:Arabic)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Aragonese</Value>
            <AddAction>addlimiter(LA99:Aragonese)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Bosnian</Value>
            <AddAction>addlimiter(LA99:Bosnian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Breton</Value>
            <AddAction>addlimiter(LA99:Breton)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Catalan; Valencian</Value>
            <AddAction>addlimiter(LA99:Catalan; Valencian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Danish</Value>
            <AddAction>addlimiter(LA99:Danish)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Dutch; Flemish</Value>
            <AddAction>addlimiter(LA99:Dutch; Flemish)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Galician</Value>
            <AddAction>addlimiter(LA99:Galician)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Indonesian</Value>
            <AddAction>addlimiter(LA99:Indonesian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Latin</Value>
            <AddAction>addlimiter(LA99:Latin)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Slavic languages</Value>
            <AddAction>addlimiter(LA99:Slavic languages)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Spanish; Castilian</Value>
            <AddAction>addlimiter(LA99:Spanish; Castilian)</AddAction>
          </LimiterValue>
          <LimiterValue>
            <Value>Ukrainian</Value>
            <AddAction>addlimiter(LA99:Ukrainian)</AddAction>
          </LimiterValue>
        </LimiterValues>
        <DefaultOn>n</DefaultOn>
        <Order>9</Order>
      </AvailableLimiter>
    </AvailableLimiters>
    <AvailableSearchModes>
      <AvailableSearchMode>
        <Mode>bool</Mode>
        <Label>Boolean/Phrase</Label>
        <DefaultOn>y</DefaultOn>
        <AddAction>setsearchmode(bool)</AddAction>
      </AvailableSearchMode>
      <AvailableSearchMode>
        <Mode>all</Mode>
        <Label>Find all my search terms</Label>
        <DefaultOn>n</DefaultOn>
        <AddAction>setsearchmode(all)</AddAction>
      </AvailableSearchMode>
      <AvailableSearchMode>
        <Mode>any</Mode>
        <Label>Find any of my search terms</Label>
        <DefaultOn>n</DefaultOn>
        <AddAction>setsearchmode(any)</AddAction>
      </AvailableSearchMode>
      <AvailableSearchMode>
        <Mode>smart</Mode>
        <Label>SmartText Searching</Label>
        <DefaultOn>n</DefaultOn>
        <AddAction>setsearchmode(smart)</AddAction>
      </AvailableSearchMode>
    </AvailableSearchModes>
    <AvailableRelatedContent>
      <AvailableRelatedContent>
        <Type>emp</Type>
        <Label>Exact Match Publication</Label>
        <DefaultOn>y</DefaultOn>
        <AddAction>includerelatedcontent(emp)</AddAction>
      </AvailableRelatedContent>
    </AvailableRelatedContent>
    <AvailableDidYouMeanOptions>
      <AvailableDidYouMeanOption>
        <Id>AutoSuggest</Id>
        <Label>Did You Mean</Label>
        <DefaultOn>y</DefaultOn>
      </AvailableDidYouMeanOption>
      <AvailableDidYouMeanOption>
        <Id>AutoCorrect</Id>
        <Label>Auto Correct</Label>
        <DefaultOn>y</DefaultOn>
      </AvailableDidYouMeanOption>
    </AvailableDidYouMeanOptions>
  </AvailableSearchCriteria>
  <ViewResultSettings>
    <ResultsPerPage>20</ResultsPerPage>
    <ResultListView>brief</ResultListView>
    <IncludeImageQuickView>
      <Id>ImageQuickViewResults</Id>
      <Label>Image Quick View Results</Label>
      <DefaultOn>n</DefaultOn>
    </IncludeImageQuickView>
  </ViewResultSettings>
  <ApplicationSettings>
    <SessionTimeout>480</SessionTimeout>
  </ApplicationSettings>
  <ApiSettings>
    <MaxRecordJumpAhead>250</MaxRecordJumpAhead>
  </ApiSettings>
  <ExportFormatSettings>
    <AvailableFormats>
      <AvailableFormat>
        <Id>RIS</Id>
        <Label>RIS Format</Label>
      </AvailableFormat>
    </AvailableFormats>
  </ExportFormatSettings>
  <CitationStyleSettings>
    <AvailableStyles>
      <AvailableStyle>
        <Id>mla</Id>
        <Label>MLA</Label>
      </AvailableStyle>
      <AvailableStyle>
        <Id>chicago</Id>
        <Label>Chicago/Turabian: Author-Date</Label>
      </AvailableStyle>
    </AvailableStyles>
  </CitationStyleSettings>
</InfoResponseMessage>

If there is an error that affects only the CitationStyleSettings element, an empty CitationStyleSettings element will be present.

{
    "AvailableSearchCriteria": {
    ...   
    "CitationStyleSettings": {}
}

<InfoResponseMessage xmlns="http://epnet.com/webservices/EbscoApi/Contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  ...
    <CitationStyleSettings/>
</InfoResponseMessage>

The response can be XML or JSON. The response format is defined by the Accept value set in the HTTP header. If the Accept value is not present in the HTTP header, the Content-type value in the HTTP header is used. The AuthTimeout value in the response is in seconds.

Best Practices

The option information for a profile changes only when you or customer satisfaction makes a modification to your profile setup. Since the options for a profile change rarely, make this call infrequently and cache the results, or call it asynchronously so search performance is not impacted. In addition, the /edsapi/rest/info endpoint doesn’t apply to just one user. So, it is reasonable to create a session for obtaining option information, then end that session. You don’t need to end the session at that point, but you need to end it before the user leaves. The /edsapi/rest/info endpoint does not need to be called for each session or search as it returns customer-level configuration settings which don’t change frequently. We recommend calling it hourly so that configuration changes flow through to the UI in a timely fashion.