The search criteria method obtains the search options available for Publication searching within a given profile. The response contains the sort options, search fields, and limiters.

Endpoint URL for Obtaining Search Options

GET http://eds-api.ebscohost.com/edsapi/publication/searchcriteria

POST http://eds-api.ebscohost.com/edsapi/publication/searchcriteria

Data Parameters

To Use the Searchcriteria Endpoint:

Gather the following information for the request.

Parameter Name	Description	Required/Optional	Parameter Type	Format	Default	Example Value
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/publication/searchcriteria supports application/xml or application/json.

Request

GET http://eds-api.ebscohost.com/edsapi/publication/searchcriteria

Response

{
   "AvailableSearchCriteria":{
      "AvailableSorts":[
         {
            "Id":"relevance",
            "Label":"Relevance",
            "AddAction":"setsort(relevance)"
         },
         {
            "Id":"title",
            "Label":"Title",
            "AddAction":"setsort(title)"
         }
      ],
      "AvailableSearchFields":[
         {
            "FieldCode":"TX",
            "Label":"All Text Fields"
         },
         {
            "FieldCode":"TI",
            "Label":"Title"
         },
         {
            "FieldCode":"IS",
            "Label":"ISSN"
         },
         {
            "FieldCode":"IB",
            "Label":"ISBN"
         },
         {
            "FieldCode":"PT",
            "Label":"Resource Type"
         },
         {
            "FieldCode":"PB",
            "Label":"Publisher"
         },
         {
            "FieldCode":"SU",
            "Label":"Subject"
         },
         {
            "FieldCode":"AU",
            "Label":"Author"
         }
      ],
      "AvailableLimiters":[
         {
            "Id":"RV3",
            "Label":"Peer Reviewed Journals",
            "Type":"select",
            "AddAction":"addlimiter(RV3:value)",
            "DefaultOn":"n",
            "Order":"1"
         }
      ]
   }
}

<SearchCriteriaResponseMessage>
  <AvailableSearchCriteria>
    <AvailableSorts>
      <AvailableSorts>
        <Id>relevance</Id>
        <Label>Relevance</Label>
        <AddAction>setsort(relevance)</AddAction>
      </AvailableSorts>
      <AvailableSorts>
        <Id>title</Id>
        <Label>Title</Label>
        <AddAction>setsort(title)</AddAction>
      </AvailableSorts>
    </AvailableSorts>
    <AvailableSearchFields>
      <AvailableSearchField>
        <FieldCode>TX</FieldCode>
        <Label>All Text Fields</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>TI</FieldCode>
        <Label>Title</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>IS</FieldCode>
        <Label>ISSN</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>IB</FieldCode>
        <Label>ISBN</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>PT</FieldCode>
        <Label>Resource Type</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>PB</FieldCode>
        <Label>Publisher</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>SU</FieldCode>
        <Label>Subject</Label>
      </AvailableSearchField>
      <AvailableSearchField>
        <FieldCode>AU</FieldCode>
        <Label>Author</Label>
      </AvailableSearchField>
    </AvailableSearchFields>
    <AvailableLimiters>
      <AvailableLimiter>
        <Id>RV3</Id>
        <Label>Peer Reviewed Journals</Label>
        <Type>select</Type>
        <AddAction>addlimiter(RV3:value)</AddAction>
        <DefaultOn>n</DefaultOn>
        <Order>1</Order>
      </AvailableLimiter>
    </AvailableLimiters>
  </AvailableSearchCriteria>

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.