GetClusters

The GetClusters method is used to return facets which organize search results into groups based on categories such as: source types, subjects, authors, publications,
companies, geography, location and content providers that are associated with a particular database(s) for a given query.

The REST and SOAP protocols will return the same results, but the parameter names are
different. Parameter names for the REST protocol are listed under the "REST" column, and
parameter names for the SOAP protocol are listed under the "SOAP" column.

REST

SOAP

Description

Required

Values

prof

Profile*

The profile used for authentication. This must be an EIT enabled profile.

Required if using profile authentication.

-

pwd

Password*

The password used for profile authentication.

Required if using profile authentication.

-

authType

AuthType*

Indicates if using IP Authentication or Profile Authentication.

Default: profile

No

profile,
ip

ipprof

IpProfile*

The profile used for authentication.

Required if using IP authentication.

-

-

IpAddress*

The IP address used for authentication.

Required if using IP authentication.

-

query

Query

Terms to be searched on.

Yes

-

db

Databases

Database(s) to perform the search on.

Yes

-

* When using the SOAP API, these items must be in the AuthorizationHeader
of the request. See Making Requests with SOAP for more information on how
to form the AuthorizationHeader.

Upon success, the first node returned should be the <clusterResponse> node (note: in SOAP, this node
is contained within the Envelope/Body/GetClustersResponse node). If there was an error, then the
first node returned would be the <Fault> node.

If the query was sucessful and returned results, the next node should be the <ClusterCategory> node. This node
contains all of the different cluster categories available for this database It has two attributes: 'ID', which is the text description
of the cluster category, and 'Tag', which is a search tag that can be used to format a query (See Formatting Queries). Each <ClusterCategory> node contains
many <Cluster> nodes. Each <Cluster> node contains the name of the cluster.