EBSCOhost

EBSCOhost Integration Toolkit

SearchService

Click here for a complete list of operations.

GetClusters

Finds and returns the set of clusters that would be returned by the given search.

To test the operation using the HTTP GET protocol, click the 'Invoke' button.

Parameter Value Default Value Notes
prof:(customerID.groupID.profileID)
  • Required Field if using Profile Authentication
pwd:
  • Required Field if using Profile Authentication
authType: profile
  • Indicates if using IP Authentication or Profile Authentication. Valid values are: (ip, profile)
ipprof:(profileID)
  • Required Field if using IP Authentication
query:
  • term to be searched on.
  • Required Field
db:(Values Separated By Commas)
  • One or more short database names to search. When used with a Non-Discovery Service Profile, this field is required.When used with a Discovery Service profile, this parameter is ignored, and all databases available to that profile are used.

The following is a sample HTTP GET response. 

<clusterResponse>
   <ClusterCategory ID="xs:string"  Tag="xs:string" >
      <Cluster>
      </Cluster>
   </ClusterCategory>
</clusterResponse>